[
https://issues.apache.org/jira/browse/MJAVADOC-572?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Robert Scholte updated MJAVADOC-572:
------------------------------------
Description:
According to the reference, custom tags like @apiNote etc. should work to
configure in the POM:
{code:xml} <tags>
<tag>
<name>apiNote</name>
<placement>a</placement>
<head>API Note:</head>
</tag>
{code}
However, when the "site" goal is executed, the build fails with JavaDoc errors
like
{noformat}
[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]
{noformat}
Are there any other settings in the POM to make this work, or does it require
custom Doclets now, too?
was:
According to the reference, custom tags like @apiNote etc. should work to
configure in the POM:
{quote}{{ <tags>}}
{{ <tag>}}
{{ <name>apiNote</name>}}
{{ <placement>a</placement>}}
{{ <head>API Note:</head>}}
{{ </tag>}}
...
{quote}
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?
> Custom Tags don't seem to work with Java 9 or above
> ---------------------------------------------------
>
> Key: MJAVADOC-572
> URL: https://issues.apache.org/jira/browse/MJAVADOC-572
> Project: Maven Javadoc Plugin
> Issue Type: Bug
> Components: javadoc
> Affects Versions: 3.0.1
> Environment: Windows
> Reporter: Werner Keil
> Priority: Major
>
> According to the reference, custom tags like @apiNote etc. should work to
> configure in the POM:
> {code:xml} <tags>
> <tag>
> <name>apiNote</name>
> <placement>a</placement>
> <head>API Note:</head>
> </tag>
> {code}
> However, when the "site" goal is executed, the build fails with JavaDoc
> errors like
> {noformat}
> [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]
> {noformat}
> Are there any other settings in the POM to make this work, or does it require
> custom Doclets now, too?
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
