Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[MJAVADOC-530] - Clean up additionalparam documentation #6

Merged
merged 1 commit into from Jul 8, 2018
Merged

[MJAVADOC-530] - Clean up additionalparam documentation #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 8 additions & 6 deletions src/site/apt/examples/alternate-doclet.apt.vm
View file
Open in desktop
Expand Up @@ -55,8 +55,9 @@ Using Alternate Doclet
<artifactId>doclet</artifactId>
<version>5.1</version>
</docletArtifact>
<additionalparam>-views</additionalparam>
<useStandardDocletOptions>true</useStandardDocletOptions>
<additionalOptions>
<additionalOption>-views</additionalOption>
</additionalOptions>
</configuration>
</plugin>
...
Expand All @@ -68,7 +69,7 @@ Using Alternate Doclet

<<Note>>:

* {{{../javadoc-mojo.html#additionalparam}\<additionalparam/\>}} parameter could be used to set additional
* {{{../javadoc-mojo.html#additionalOptions}\<additionalOptions/\>}} parameter could be used to set additional
parameters on the command line, specifically for doclet options.

* {{{../javadoc-mojo.html#useStandardDocletOptions}\<useStandardDocletOptions/\>}} parameter could be used to specify
Expand Down Expand Up @@ -119,9 +120,10 @@ Using Alternate Doclet In Addition To The Javadoc Doclet
<artifactId>doccheck</artifactId>
<version>1.2b2</version>
</docletArtifact>
<additionalparam>
-d \${project.build.directory}/site/doccheck
</additionalparam>
<additionalOptions>
<additionalOption>-d</additionalOption>
<additionalOption>\${project.build.directory}/site/doccheck</additionalOption>
</additionalOptions>

<!-- Other dir than apidocs -->
<destDir>doccheck</destDir>
Expand Down
4 changes: 2 additions & 2 deletions src/site/fml/faq.fml
View file
Open in desktop
Expand Up @@ -97,7 +97,7 @@ javadoc.exe(or .sh) @options @packages | @argfile]]></source>
You could need to add more Javadoc parameters to be process by the Javadoc Tool (i.e. for doclet).
</p>
<p>
For this, you should use the <i>&lt;additionalparam/&gt;</i> parameter in your Javadoc Plugin configuration.
For this, you should use the <i>&lt;additionalOptions/&gt;</i> parameter in your Javadoc Plugin configuration.
</p>
</answer>
</faq>
Expand Down Expand Up @@ -454,4 +454,4 @@ mvn deploy:deploy-file \
</answer>
</faq>
</part>
</faqs>
</faqs>