dolfdijkstra / gst-foundation

Sites Global Foundation Project
Apache License 2.0
13 stars 14 forks source link

Update all javadocs to conform to Java8/doclint #46

Closed amai closed 8 years ago

amai commented 8 years ago

This update removes the need for the doclint workaround (the workaround was using the configuration`-Xdoclint:none within the javadoc-plugin in the build file to ignore all errors by turning off doclint entirely.

All javadoc comments now conform to the doclint standard, W3C HTML 4.01 HTML.

All parameters now have descriptions, all return values are declared with descriptions, and all html tag and code tags in javadoc comments are escaped or wrapped by {@literal } or {@code}.

The extra profile configuration (shown below) in the relevant pom.xml files has been removed:

<profiles>
    <profile>
        <id>disable-java8-doclint</id>
        <activation>
            <jdk>[1.8,)</jdk>           
                </activation>
        <properties>
                <additionalparam>-Xdoclint:none</additionalparam>
        </properties>
    </profile>
</profiles>

There is also a minor update to the README for typos.