Merge pull request #6 from marschall/MJAVADOC-530

[MJAVADOC-530] - Clean up additionalparam documentation
apache · Jul 8, 2018 · 4e95ecf · 4e95ecf
2 parents e2e0316 + 976b8d2
commit 4e95ecf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/src/site/apt/examples/alternate-doclet.apt.vm b/src/site/apt/examples/alternate-doclet.apt.vm
@@ -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>
     ...
@@ -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
@@ -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>

diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
@@ -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>
@@ -454,4 +454,4 @@ mvn deploy:deploy-file \
       </answer>
     </faq>
   </part>
-</faqs>
+</faqs>