Use maven JavaDoc with reasonable doclint options

There is a lot of information on how to disable the holy JavaDoc lint function in Java 8. Believe it or not, today I decided to use this functionality and fix my JavaDocs. However, in his standard configuration, he complains about all the possible missing @paramand @return. From what I see in the JavaDoc documentation in Java 8 javadoc technotes , my choice is -Xdoclint:all,-missing. This should include all checks, but not leave complaints about missed documentation features. The maven configuration looks like this:

  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>2.10.4</version>
        <configuration>
          <additionalparam>-Xdoclint:all,-missing</additionalparam>
          <aggregate>false</aggregate>
        </configuration>
        <reportSets>
          <reportSet>
            <id>default</id>
            <reports>
              <report>javadoc</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
    </plugins>
  </reporting>

However, when I start with, mvn siteI get an error message:

[ERROR] Exit code: 1 - javadoc: error - invalid flag: -missing

I suspect that handling parameters in maven is a problem, however quoting did not help.

, ? JavaDoc ?

+4
2

:

-Xdoclint:all -Xdoclint:-missing 
+2

, (-Xdoclint:all,-missing), . javadoc. , Maven JavaDoc Plugin, , , . MJAVADOC-368.

, , @hasnae (-Xdoclint:all -Xdoclint:-missing).

+3

Source: https://habr.com/ru/post/1653697/


All Articles