Fix javadoc

[IgorRodchenkov]

Comments and, more important, javadoc aren't in great shape here - tons of errors, such as public API methods lack parameter and return value descriptions, use '>' and '<' and other bad symbols, etc. If you guys would really like to make this useful for everyone (and I am pretty sure this this what you promised in your grant/funding applications) tool and eventually deploy/release to OSSRH and then to Maven Central, you have to fix the javadoc (and perhaps much more...).
Try, e.g, adding to the pom.xml the following (to the element):

                    <plugin>
                        <artifactId>maven-javadoc-plugin</artifactId>
                        <version>2.10.2</version>
                        <executions>
                            <execution>
                                <id>attach-javadocs</id>
                                <goals>
                                    <goal>jar</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>

and then run: mvn clean install

(I forked this code and already tired cleaning up and fixing; so I gave up...)