Uploaded image for project: 'Maven Javadoc Plugin'
  1. Maven Javadoc Plugin
  2. MJAVADOC-572

Custom Tags don't seem to work with Java 9 or above

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Major
    • Resolution: Incomplete
    • 3.0.1
    • None
    • javadoc
    • None
    • Windows

    Description

      According to the reference, custom tags like @apiNote etc. should work to configure in the POM:

       <tags>
       <tag>
       <name>apiNote</name>
       <placement>a</placement>
       <head>API Note:</head>
       </tag>
      

      However, when the "site" goal is executed, the build fails with JavaDoc errors like

      [INFO] Generating "Javadoc" report --- maven-javadoc-plugin:3.0.1:javadoc
      [INFO]
      1 error
      [INFO] ------------------------------------------------------------------------
      [INFO] BUILD FAILURE
      [INFO] ------------------------------------------------------------------------
      [INFO] Total time: 31.099 s
      [INFO] Finished at: 2019-01-28T19:27:02+01:00
      [INFO] ------------------------------------------------------------------------
      [ERROR] Failed to execute goal org.apache.maven.plugins:maven-site-plugin:3.7.1:site (default-site) on project unit-api: Error generating maven-javadoc-plugin:3.0.1:javadoc report:
      [ERROR] Exit code: 1 - git_home\unit-api\src\main\java\javax\measure\quantity\Temperature.java:41: error: unknown tag: apiNote
      [ERROR] * @apiNote SI Base Unit
      [ERROR] ^
      [ERROR]
      [ERROR] Command line was: "C:\Program Files\Java\jdk-9.0.4\bin\javadoc.exe" @options @packages
      [ERROR]
      [ERROR] Refer to the generated Javadoc files in 'git_home\unit-api\target\site\apidocs' dir.
      [ERROR] -> [Help 1]
      [ERROR]
      [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
      [ERROR] Re-run Maven using the -X switch to enable full debug logging.
      [ERROR]
      [ERROR] For more information about the errors and possible solutions, please read the following articles:
      [ERROR] [Help 1] [http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException]
      

      Are there any other settings in the POM to make this work, or does it require custom Doclets now, too?

      Attachments

        Activity

          People

            rfscholte Robert Scholte
            wkeil Werner Keil
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: