[GitHub] rfscholte closed pull request #6: [MJAVADOC-530] - Clean up additionalparam documentation

[GitBox <gi...@apache.org>]

rfscholte closed pull request #6: [MJAVADOC-530] - Clean up additionalparam documentation
URL: https://github.com/apache/maven-javadoc-plugin/pull/6
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/src/site/apt/examples/alternate-doclet.apt.vm b/src/site/apt/examples/alternate-doclet.apt.vm
index 5b02dce..04cbbbc 100644
--- 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
index 5e876bd..290f157 100644
--- 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>
\ No newline at end of file
+</faqs>


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services