Coverage Report - org.apache.maven.plugin.javadoc.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0 %
0/4112
0 %
0/142
8
 
 1  
 package org.apache.maven.plugin.javadoc;
 2  
 
 3  
 import java.util.ArrayList;
 4  
 import java.util.Iterator;
 5  
 import java.util.List;
 6  
 
 7  
 import org.apache.maven.plugin.AbstractMojo;
 8  
 import org.apache.maven.plugin.MojoExecutionException;
 9  
 
 10  
 /**
 11  
  * Display help information on maven-javadoc-plugin.<br/> Call <pre>  mvn javadoc:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details.
 12  
  *
 13  
  * @version generated on Mon May 02 01:00:32 CEST 2011
 14  
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.7)
 15  
  * @goal help
 16  
  * @requiresProject false
 17  
  * @threadSafe
 18  
  */
 19  0
 public class HelpMojo
 20  
     extends AbstractMojo
 21  
 {
 22  
     /**
 23  
      * If <code>true</code>, display all settable properties for each goal.
 24  
      * 
 25  
      * @parameter expression="${detail}" default-value="false"
 26  
      */
 27  
     private boolean detail;
 28  
 
 29  
     /**
 30  
      * The name of the goal for which to show help. If unspecified, all goals will be displayed.
 31  
      * 
 32  
      * @parameter expression="${goal}"
 33  
      */
 34  
     private java.lang.String goal;
 35  
 
 36  
     /**
 37  
      * The maximum length of a display line, should be positive.
 38  
      * 
 39  
      * @parameter expression="${lineLength}" default-value="80"
 40  
      */
 41  
     private int lineLength;
 42  
 
 43  
     /**
 44  
      * The number of spaces per indentation level, should be positive.
 45  
      * 
 46  
      * @parameter expression="${indentSize}" default-value="2"
 47  
      */
 48  
     private int indentSize;
 49  
 
 50  
 
 51  
     /** {@inheritDoc} */
 52  
     public void execute()
 53  
         throws MojoExecutionException
 54  
     {
 55  0
         if ( lineLength <= 0 )
 56  
         {
 57  0
             getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
 58  0
             lineLength = 80;
 59  
         }
 60  0
         if ( indentSize <= 0 )
 61  
         {
 62  0
             getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
 63  0
             indentSize = 2;
 64  
         }
 65  
 
 66  0
         StringBuffer sb = new StringBuffer();
 67  
 
 68  0
         append( sb, "org.apache.maven.plugins:maven-javadoc-plugin:2.8", 0 );
 69  0
         append( sb, "", 0 );
 70  
 
 71  0
         append( sb, "Maven Javadoc Plugin", 0 );
 72  0
         append( sb, "The Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.", 1 );
 73  0
         append( sb, "", 0 );
 74  
 
 75  0
         if ( goal == null || goal.length() <= 0 )
 76  
         {
 77  0
             append( sb, "This plugin has 13 goals:", 0 );
 78  0
             append( sb, "", 0 );
 79  
         }
 80  
 
 81  0
         if ( goal == null || goal.length() <= 0 || "aggregate".equals( goal ) )
 82  
         {
 83  0
             append( sb, "javadoc:aggregate", 0 );
 84  0
             append( sb, "Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.", 1 );
 85  0
             append( sb, "", 0 );
 86  0
             if ( detail )
 87  
             {
 88  0
                 append( sb, "Available parameters:", 1 );
 89  0
                 append( sb, "", 0 );
 90  
 
 91  0
                 append( sb, "additionalJOption", 2 );
 92  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 93  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 94  0
                 append( sb, "", 0 );
 95  
 
 96  0
                 append( sb, "additionalparam", 2 );
 97  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 98  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 99  0
                 append( sb, "", 0 );
 100  
 
 101  0
                 append( sb, "aggregate (Default: false)", 2 );
 102  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 103  0
                 append( sb, "", 0 );
 104  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 105  0
                 append( sb, "Expression: ${aggregate}", 3 );
 106  0
                 append( sb, "", 0 );
 107  
 
 108  0
                 append( sb, "author (Default: true)", 2 );
 109  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 110  0
                 append( sb, "Expression: ${author}", 3 );
 111  0
                 append( sb, "", 0 );
 112  
 
 113  0
                 append( sb, "bootclasspath", 2 );
 114  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 115  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 116  0
                 append( sb, "", 0 );
 117  
 
 118  0
                 append( sb, "bootclasspathArtifacts", 2 );
 119  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 120  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 121  0
                 append( sb, "", 0 );
 122  
 
 123  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 124  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 125  0
                 append( sb, "Expression: ${bottom}", 3 );
 126  0
                 append( sb, "", 0 );
 127  
 
 128  0
                 append( sb, "breakiterator (Default: false)", 2 );
 129  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 130  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 131  0
                 append( sb, "", 0 );
 132  
 
 133  0
                 append( sb, "charset", 2 );
 134  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 135  0
                 append( sb, "Expression: ${charset}", 3 );
 136  0
                 append( sb, "", 0 );
 137  
 
 138  0
                 append( sb, "debug (Default: false)", 2 );
 139  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 140  0
                 append( sb, "Expression: ${debug}", 3 );
 141  0
                 append( sb, "", 0 );
 142  
 
 143  0
                 append( sb, "dependencySourceExcludes", 2 );
 144  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 145  0
                 append( sb, "", 0 );
 146  
 
 147  0
                 append( sb, "dependencySourceIncludes", 2 );
 148  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 149  0
                 append( sb, "", 0 );
 150  
 
 151  0
                 append( sb, "description", 2 );
 152  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 153  0
                 append( sb, "Expression: ${description}", 3 );
 154  0
                 append( sb, "", 0 );
 155  
 
 156  0
                 append( sb, "destDir (Default: apidocs)", 2 );
 157  0
                 append( sb, "The name of the destination directory.\n", 3 );
 158  0
                 append( sb, "Expression: ${destDir}", 3 );
 159  0
                 append( sb, "", 0 );
 160  
 
 161  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 162  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 163  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 164  0
                 append( sb, "", 0 );
 165  
 
 166  0
                 append( sb, "detectLinks (Default: false)", 2 );
 167  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 168  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 169  0
                 append( sb, "", 0 );
 170  
 
 171  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 172  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 173  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 174  0
                 append( sb, "", 0 );
 175  
 
 176  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 177  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 178  0
                 append( sb, "Expression: ${docencoding}", 3 );
 179  0
                 append( sb, "", 0 );
 180  
 
 181  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 182  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 183  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 184  0
                 append( sb, "", 0 );
 185  
 
 186  0
                 append( sb, "doclet", 2 );
 187  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 188  0
                 append( sb, "Expression: ${doclet}", 3 );
 189  0
                 append( sb, "", 0 );
 190  
 
 191  0
                 append( sb, "docletArtifact", 2 );
 192  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 193  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 194  0
                 append( sb, "", 0 );
 195  
 
 196  0
                 append( sb, "docletArtifacts", 2 );
 197  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 198  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 199  0
                 append( sb, "", 0 );
 200  
 
 201  0
                 append( sb, "docletPath", 2 );
 202  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 203  0
                 append( sb, "Expression: ${docletPath}", 3 );
 204  0
                 append( sb, "", 0 );
 205  
 
 206  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 207  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 208  0
                 append( sb, "Expression: ${doctitle}", 3 );
 209  0
                 append( sb, "", 0 );
 210  
 
 211  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 212  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 213  0
                 append( sb, "Expression: ${encoding}", 3 );
 214  0
                 append( sb, "", 0 );
 215  
 
 216  0
                 append( sb, "excludedocfilessubdir", 2 );
 217  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 218  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 219  0
                 append( sb, "", 0 );
 220  
 
 221  0
                 append( sb, "excludePackageNames", 2 );
 222  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 223  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 224  0
                 append( sb, "", 0 );
 225  
 
 226  0
                 append( sb, "extdirs", 2 );
 227  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 228  0
                 append( sb, "Expression: ${extdirs}", 3 );
 229  0
                 append( sb, "", 0 );
 230  
 
 231  0
                 append( sb, "failOnError (Default: true)", 2 );
 232  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 233  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 234  0
                 append( sb, "", 0 );
 235  
 
 236  0
                 append( sb, "footer", 2 );
 237  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 238  0
                 append( sb, "Expression: ${footer}", 3 );
 239  0
                 append( sb, "", 0 );
 240  
 
 241  0
                 append( sb, "groups", 2 );
 242  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 243  0
                 append( sb, "Expression: ${groups}", 3 );
 244  0
                 append( sb, "", 0 );
 245  
 
 246  0
                 append( sb, "header", 2 );
 247  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 248  0
                 append( sb, "Expression: ${header}", 3 );
 249  0
                 append( sb, "", 0 );
 250  
 
 251  0
                 append( sb, "helpfile", 2 );
 252  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 253  0
                 append( sb, "Expression: ${helpfile}", 3 );
 254  0
                 append( sb, "", 0 );
 255  
 
 256  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 257  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 258  0
                 append( sb, "", 0 );
 259  
 
 260  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 261  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 262  0
                 append( sb, "", 0 );
 263  
 
 264  0
                 append( sb, "javaApiLinks", 2 );
 265  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 266  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 267  0
                 append( sb, "", 0 );
 268  
 
 269  0
                 append( sb, "javadocDirectory", 2 );
 270  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 271  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 272  0
                 append( sb, "", 0 );
 273  
 
 274  0
                 append( sb, "javadocExecutable", 2 );
 275  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 276  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 277  0
                 append( sb, "", 0 );
 278  
 
 279  0
                 append( sb, "javadocVersion", 2 );
 280  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 281  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 282  0
                 append( sb, "", 0 );
 283  
 
 284  0
                 append( sb, "keywords (Default: false)", 2 );
 285  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 286  0
                 append( sb, "Expression: ${keywords}", 3 );
 287  0
                 append( sb, "", 0 );
 288  
 
 289  0
                 append( sb, "links", 2 );
 290  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 291  0
                 append( sb, "Expression: ${links}", 3 );
 292  0
                 append( sb, "", 0 );
 293  
 
 294  0
                 append( sb, "linksource (Default: false)", 2 );
 295  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 296  0
                 append( sb, "Expression: ${linksource}", 3 );
 297  0
                 append( sb, "", 0 );
 298  
 
 299  0
                 append( sb, "locale", 2 );
 300  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 301  0
                 append( sb, "Expression: ${locale}", 3 );
 302  0
                 append( sb, "", 0 );
 303  
 
 304  0
                 append( sb, "localRepository", 2 );
 305  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 306  0
                 append( sb, "Expression: ${localRepository}", 3 );
 307  0
                 append( sb, "", 0 );
 308  
 
 309  0
                 append( sb, "maxmemory", 2 );
 310  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 311  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 312  0
                 append( sb, "", 0 );
 313  
 
 314  0
                 append( sb, "minmemory", 2 );
 315  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 316  0
                 append( sb, "Expression: ${minmemory}", 3 );
 317  0
                 append( sb, "", 0 );
 318  
 
 319  0
                 append( sb, "name", 2 );
 320  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 321  0
                 append( sb, "Expression: ${name}", 3 );
 322  0
                 append( sb, "", 0 );
 323  
 
 324  0
                 append( sb, "nocomment (Default: false)", 2 );
 325  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 326  0
                 append( sb, "Expression: ${nocomment}", 3 );
 327  0
                 append( sb, "", 0 );
 328  
 
 329  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 330  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 331  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 332  0
                 append( sb, "", 0 );
 333  
 
 334  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 335  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 336  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 337  0
                 append( sb, "", 0 );
 338  
 
 339  0
                 append( sb, "nohelp (Default: false)", 2 );
 340  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 341  0
                 append( sb, "Expression: ${nohelp}", 3 );
 342  0
                 append( sb, "", 0 );
 343  
 
 344  0
                 append( sb, "noindex (Default: false)", 2 );
 345  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 346  0
                 append( sb, "Expression: ${noindex}", 3 );
 347  0
                 append( sb, "", 0 );
 348  
 
 349  0
                 append( sb, "nonavbar (Default: false)", 2 );
 350  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 351  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 352  0
                 append( sb, "", 0 );
 353  
 
 354  0
                 append( sb, "nooverview (Default: false)", 2 );
 355  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 356  0
                 append( sb, "Expression: ${nooverview}", 3 );
 357  0
                 append( sb, "", 0 );
 358  
 
 359  0
                 append( sb, "noqualifier", 2 );
 360  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 361  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 362  0
                 append( sb, "", 0 );
 363  
 
 364  0
                 append( sb, "nosince (Default: false)", 2 );
 365  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 366  0
                 append( sb, "Expression: ${nosince}", 3 );
 367  0
                 append( sb, "", 0 );
 368  
 
 369  0
                 append( sb, "notimestamp (Default: false)", 2 );
 370  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 371  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 372  0
                 append( sb, "", 0 );
 373  
 
 374  0
                 append( sb, "notree (Default: false)", 2 );
 375  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 376  0
                 append( sb, "Expression: ${notree}", 3 );
 377  0
                 append( sb, "", 0 );
 378  
 
 379  0
                 append( sb, "offlineLinks", 2 );
 380  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 381  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 382  0
                 append( sb, "", 0 );
 383  
 
 384  0
                 append( sb, "old (Default: false)", 2 );
 385  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 386  0
                 append( sb, "Expression: ${old}", 3 );
 387  0
                 append( sb, "", 0 );
 388  
 
 389  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 390  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 391  0
                 append( sb, "Required: Yes", 3 );
 392  0
                 append( sb, "Expression: ${destDir}", 3 );
 393  0
                 append( sb, "", 0 );
 394  
 
 395  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 396  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 397  0
                 append( sb, "Expression: ${overview}", 3 );
 398  0
                 append( sb, "", 0 );
 399  
 
 400  0
                 append( sb, "packagesheader", 2 );
 401  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 402  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 403  0
                 append( sb, "", 0 );
 404  
 
 405  0
                 append( sb, "proxyHost", 2 );
 406  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 407  0
                 append( sb, "", 0 );
 408  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 409  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 410  0
                 append( sb, "", 0 );
 411  
 
 412  0
                 append( sb, "proxyPort", 2 );
 413  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 414  0
                 append( sb, "", 0 );
 415  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 416  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 417  0
                 append( sb, "", 0 );
 418  
 
 419  0
                 append( sb, "quiet (Default: false)", 2 );
 420  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 421  0
                 append( sb, "Expression: ${quiet}", 3 );
 422  0
                 append( sb, "", 0 );
 423  
 
 424  0
                 append( sb, "remoteRepositories", 2 );
 425  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 426  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 427  0
                 append( sb, "", 0 );
 428  
 
 429  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
 430  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 431  0
                 append( sb, "Required: Yes", 3 );
 432  0
                 append( sb, "Expression: ${reportOutputDirectory}", 3 );
 433  0
                 append( sb, "", 0 );
 434  
 
 435  0
                 append( sb, "resourcesArtifacts", 2 );
 436  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 437  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 438  0
                 append( sb, "", 0 );
 439  
 
 440  0
                 append( sb, "serialwarn (Default: false)", 2 );
 441  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 442  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 443  0
                 append( sb, "", 0 );
 444  
 
 445  0
                 append( sb, "show (Default: protected)", 2 );
 446  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 447  0
                 append( sb, "Expression: ${show}", 3 );
 448  0
                 append( sb, "", 0 );
 449  
 
 450  0
                 append( sb, "skip (Default: false)", 2 );
 451  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 452  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 453  0
                 append( sb, "", 0 );
 454  
 
 455  0
                 append( sb, "source", 2 );
 456  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 457  0
                 append( sb, "Expression: ${source}", 3 );
 458  0
                 append( sb, "", 0 );
 459  
 
 460  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 461  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 462  0
                 append( sb, "", 0 );
 463  
 
 464  0
                 append( sb, "sourcepath", 2 );
 465  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 466  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 467  0
                 append( sb, "", 0 );
 468  
 
 469  0
                 append( sb, "sourcetab", 2 );
 470  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 471  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 472  0
                 append( sb, "", 0 );
 473  
 
 474  0
                 append( sb, "splitindex (Default: false)", 2 );
 475  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 476  0
                 append( sb, "Expression: ${splitindex}", 3 );
 477  0
                 append( sb, "", 0 );
 478  
 
 479  0
                 append( sb, "stylesheet (Default: java)", 2 );
 480  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 481  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 482  0
                 append( sb, "", 0 );
 483  
 
 484  0
                 append( sb, "stylesheetfile", 2 );
 485  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 486  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 487  0
                 append( sb, "", 0 );
 488  
 
 489  0
                 append( sb, "subpackages", 2 );
 490  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 491  0
                 append( sb, "Expression: ${subpackages}", 3 );
 492  0
                 append( sb, "", 0 );
 493  
 
 494  0
                 append( sb, "taglet", 2 );
 495  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 496  0
                 append( sb, "Expression: ${taglet}", 3 );
 497  0
                 append( sb, "", 0 );
 498  
 
 499  0
                 append( sb, "tagletArtifact", 2 );
 500  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 501  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 502  0
                 append( sb, "", 0 );
 503  
 
 504  0
                 append( sb, "tagletArtifacts", 2 );
 505  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 506  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 507  0
                 append( sb, "", 0 );
 508  
 
 509  0
                 append( sb, "tagletpath", 2 );
 510  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 511  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 512  0
                 append( sb, "", 0 );
 513  
 
 514  0
                 append( sb, "taglets", 2 );
 515  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 516  0
                 append( sb, "Expression: ${taglets}", 3 );
 517  0
                 append( sb, "", 0 );
 518  
 
 519  0
                 append( sb, "tags", 2 );
 520  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 521  0
                 append( sb, "Expression: ${tags}", 3 );
 522  0
                 append( sb, "", 0 );
 523  
 
 524  0
                 append( sb, "top", 2 );
 525  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 526  0
                 append( sb, "Expression: ${top}", 3 );
 527  0
                 append( sb, "", 0 );
 528  
 
 529  0
                 append( sb, "use (Default: true)", 2 );
 530  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 531  0
                 append( sb, "Expression: ${use}", 3 );
 532  0
                 append( sb, "", 0 );
 533  
 
 534  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 535  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 536  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 537  0
                 append( sb, "", 0 );
 538  
 
 539  0
                 append( sb, "validateLinks (Default: false)", 2 );
 540  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 541  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 542  0
                 append( sb, "", 0 );
 543  
 
 544  0
                 append( sb, "verbose (Default: false)", 2 );
 545  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 546  0
                 append( sb, "Expression: ${verbose}", 3 );
 547  0
                 append( sb, "", 0 );
 548  
 
 549  0
                 append( sb, "version (Default: true)", 2 );
 550  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 551  0
                 append( sb, "Expression: ${version}", 3 );
 552  0
                 append( sb, "", 0 );
 553  
 
 554  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 555  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 556  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 557  0
                 append( sb, "", 0 );
 558  
             }
 559  
         }
 560  
 
 561  0
         if ( goal == null || goal.length() <= 0 || "aggregate-jar".equals( goal ) )
 562  
         {
 563  0
             append( sb, "javadoc:aggregate-jar", 0 );
 564  0
             append( sb, "Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
 565  0
             append( sb, "", 0 );
 566  0
             if ( detail )
 567  
             {
 568  0
                 append( sb, "Available parameters:", 1 );
 569  0
                 append( sb, "", 0 );
 570  
 
 571  0
                 append( sb, "additionalJOption", 2 );
 572  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 573  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 574  0
                 append( sb, "", 0 );
 575  
 
 576  0
                 append( sb, "additionalparam", 2 );
 577  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 578  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 579  0
                 append( sb, "", 0 );
 580  
 
 581  0
                 append( sb, "aggregate (Default: false)", 2 );
 582  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 583  0
                 append( sb, "", 0 );
 584  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 585  0
                 append( sb, "Expression: ${aggregate}", 3 );
 586  0
                 append( sb, "", 0 );
 587  
 
 588  0
                 append( sb, "archive", 2 );
 589  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 590  0
                 append( sb, "", 0 );
 591  
 
 592  0
                 append( sb, "attach (Default: true)", 2 );
 593  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 594  0
                 append( sb, "Expression: ${attach}", 3 );
 595  0
                 append( sb, "", 0 );
 596  
 
 597  0
                 append( sb, "author (Default: true)", 2 );
 598  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 599  0
                 append( sb, "Expression: ${author}", 3 );
 600  0
                 append( sb, "", 0 );
 601  
 
 602  0
                 append( sb, "bootclasspath", 2 );
 603  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 604  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 605  0
                 append( sb, "", 0 );
 606  
 
 607  0
                 append( sb, "bootclasspathArtifacts", 2 );
 608  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 609  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 610  0
                 append( sb, "", 0 );
 611  
 
 612  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 613  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 614  0
                 append( sb, "Expression: ${bottom}", 3 );
 615  0
                 append( sb, "", 0 );
 616  
 
 617  0
                 append( sb, "breakiterator (Default: false)", 2 );
 618  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 619  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 620  0
                 append( sb, "", 0 );
 621  
 
 622  0
                 append( sb, "charset", 2 );
 623  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 624  0
                 append( sb, "Expression: ${charset}", 3 );
 625  0
                 append( sb, "", 0 );
 626  
 
 627  0
                 append( sb, "debug (Default: false)", 2 );
 628  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 629  0
                 append( sb, "Expression: ${debug}", 3 );
 630  0
                 append( sb, "", 0 );
 631  
 
 632  0
                 append( sb, "dependencySourceExcludes", 2 );
 633  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 634  0
                 append( sb, "", 0 );
 635  
 
 636  0
                 append( sb, "dependencySourceIncludes", 2 );
 637  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 638  0
                 append( sb, "", 0 );
 639  
 
 640  0
                 append( sb, "destDir", 2 );
 641  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 642  0
                 append( sb, "Expression: ${destDir}", 3 );
 643  0
                 append( sb, "", 0 );
 644  
 
 645  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 646  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 647  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 648  0
                 append( sb, "", 0 );
 649  
 
 650  0
                 append( sb, "detectLinks (Default: false)", 2 );
 651  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 652  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 653  0
                 append( sb, "", 0 );
 654  
 
 655  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 656  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 657  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 658  0
                 append( sb, "", 0 );
 659  
 
 660  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 661  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 662  0
                 append( sb, "Expression: ${docencoding}", 3 );
 663  0
                 append( sb, "", 0 );
 664  
 
 665  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 666  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 667  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 668  0
                 append( sb, "", 0 );
 669  
 
 670  0
                 append( sb, "doclet", 2 );
 671  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 672  0
                 append( sb, "Expression: ${doclet}", 3 );
 673  0
                 append( sb, "", 0 );
 674  
 
 675  0
                 append( sb, "docletArtifact", 2 );
 676  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 677  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 678  0
                 append( sb, "", 0 );
 679  
 
 680  0
                 append( sb, "docletArtifacts", 2 );
 681  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 682  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 683  0
                 append( sb, "", 0 );
 684  
 
 685  0
                 append( sb, "docletPath", 2 );
 686  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 687  0
                 append( sb, "Expression: ${docletPath}", 3 );
 688  0
                 append( sb, "", 0 );
 689  
 
 690  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 691  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 692  0
                 append( sb, "Expression: ${doctitle}", 3 );
 693  0
                 append( sb, "", 0 );
 694  
 
 695  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 696  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 697  0
                 append( sb, "Expression: ${encoding}", 3 );
 698  0
                 append( sb, "", 0 );
 699  
 
 700  0
                 append( sb, "excludedocfilessubdir", 2 );
 701  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 702  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 703  0
                 append( sb, "", 0 );
 704  
 
 705  0
                 append( sb, "excludePackageNames", 2 );
 706  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 707  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 708  0
                 append( sb, "", 0 );
 709  
 
 710  0
                 append( sb, "extdirs", 2 );
 711  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 712  0
                 append( sb, "Expression: ${extdirs}", 3 );
 713  0
                 append( sb, "", 0 );
 714  
 
 715  0
                 append( sb, "failOnError (Default: true)", 2 );
 716  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 717  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 718  0
                 append( sb, "", 0 );
 719  
 
 720  0
                 append( sb, "finalName", 2 );
 721  0
                 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
 722  0
                 append( sb, "Expression: ${project.build.finalName}", 3 );
 723  0
                 append( sb, "", 0 );
 724  
 
 725  0
                 append( sb, "footer", 2 );
 726  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 727  0
                 append( sb, "Expression: ${footer}", 3 );
 728  0
                 append( sb, "", 0 );
 729  
 
 730  0
                 append( sb, "groups", 2 );
 731  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 732  0
                 append( sb, "Expression: ${groups}", 3 );
 733  0
                 append( sb, "", 0 );
 734  
 
 735  0
                 append( sb, "header", 2 );
 736  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 737  0
                 append( sb, "Expression: ${header}", 3 );
 738  0
                 append( sb, "", 0 );
 739  
 
 740  0
                 append( sb, "helpfile", 2 );
 741  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 742  0
                 append( sb, "Expression: ${helpfile}", 3 );
 743  0
                 append( sb, "", 0 );
 744  
 
 745  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 746  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 747  0
                 append( sb, "", 0 );
 748  
 
 749  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 750  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 751  0
                 append( sb, "", 0 );
 752  
 
 753  0
                 append( sb, "jarOutputDirectory", 2 );
 754  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 755  0
                 append( sb, "Expression: ${project.build.directory}", 3 );
 756  0
                 append( sb, "", 0 );
 757  
 
 758  0
                 append( sb, "javaApiLinks", 2 );
 759  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 760  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 761  0
                 append( sb, "", 0 );
 762  
 
 763  0
                 append( sb, "javadocDirectory", 2 );
 764  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 765  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 766  0
                 append( sb, "", 0 );
 767  
 
 768  0
                 append( sb, "javadocExecutable", 2 );
 769  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 770  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 771  0
                 append( sb, "", 0 );
 772  
 
 773  0
                 append( sb, "javadocVersion", 2 );
 774  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 775  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 776  0
                 append( sb, "", 0 );
 777  
 
 778  0
                 append( sb, "keywords (Default: false)", 2 );
 779  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 780  0
                 append( sb, "Expression: ${keywords}", 3 );
 781  0
                 append( sb, "", 0 );
 782  
 
 783  0
                 append( sb, "links", 2 );
 784  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 785  0
                 append( sb, "Expression: ${links}", 3 );
 786  0
                 append( sb, "", 0 );
 787  
 
 788  0
                 append( sb, "linksource (Default: false)", 2 );
 789  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 790  0
                 append( sb, "Expression: ${linksource}", 3 );
 791  0
                 append( sb, "", 0 );
 792  
 
 793  0
                 append( sb, "locale", 2 );
 794  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 795  0
                 append( sb, "Expression: ${locale}", 3 );
 796  0
                 append( sb, "", 0 );
 797  
 
 798  0
                 append( sb, "localRepository", 2 );
 799  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 800  0
                 append( sb, "Expression: ${localRepository}", 3 );
 801  0
                 append( sb, "", 0 );
 802  
 
 803  0
                 append( sb, "maxmemory", 2 );
 804  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 805  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 806  0
                 append( sb, "", 0 );
 807  
 
 808  0
                 append( sb, "minmemory", 2 );
 809  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 810  0
                 append( sb, "Expression: ${minmemory}", 3 );
 811  0
                 append( sb, "", 0 );
 812  
 
 813  0
                 append( sb, "nocomment (Default: false)", 2 );
 814  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 815  0
                 append( sb, "Expression: ${nocomment}", 3 );
 816  0
                 append( sb, "", 0 );
 817  
 
 818  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 819  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 820  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 821  0
                 append( sb, "", 0 );
 822  
 
 823  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 824  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 825  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 826  0
                 append( sb, "", 0 );
 827  
 
 828  0
                 append( sb, "nohelp (Default: false)", 2 );
 829  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 830  0
                 append( sb, "Expression: ${nohelp}", 3 );
 831  0
                 append( sb, "", 0 );
 832  
 
 833  0
                 append( sb, "noindex (Default: false)", 2 );
 834  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 835  0
                 append( sb, "Expression: ${noindex}", 3 );
 836  0
                 append( sb, "", 0 );
 837  
 
 838  0
                 append( sb, "nonavbar (Default: false)", 2 );
 839  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 840  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 841  0
                 append( sb, "", 0 );
 842  
 
 843  0
                 append( sb, "nooverview (Default: false)", 2 );
 844  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 845  0
                 append( sb, "Expression: ${nooverview}", 3 );
 846  0
                 append( sb, "", 0 );
 847  
 
 848  0
                 append( sb, "noqualifier", 2 );
 849  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 850  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 851  0
                 append( sb, "", 0 );
 852  
 
 853  0
                 append( sb, "nosince (Default: false)", 2 );
 854  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 855  0
                 append( sb, "Expression: ${nosince}", 3 );
 856  0
                 append( sb, "", 0 );
 857  
 
 858  0
                 append( sb, "notimestamp (Default: false)", 2 );
 859  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 860  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 861  0
                 append( sb, "", 0 );
 862  
 
 863  0
                 append( sb, "notree (Default: false)", 2 );
 864  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 865  0
                 append( sb, "Expression: ${notree}", 3 );
 866  0
                 append( sb, "", 0 );
 867  
 
 868  0
                 append( sb, "offlineLinks", 2 );
 869  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 870  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 871  0
                 append( sb, "", 0 );
 872  
 
 873  0
                 append( sb, "old (Default: false)", 2 );
 874  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 875  0
                 append( sb, "Expression: ${old}", 3 );
 876  0
                 append( sb, "", 0 );
 877  
 
 878  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 879  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 880  0
                 append( sb, "Required: Yes", 3 );
 881  0
                 append( sb, "Expression: ${destDir}", 3 );
 882  0
                 append( sb, "", 0 );
 883  
 
 884  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 885  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 886  0
                 append( sb, "Expression: ${overview}", 3 );
 887  0
                 append( sb, "", 0 );
 888  
 
 889  0
                 append( sb, "packagesheader", 2 );
 890  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 891  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 892  0
                 append( sb, "", 0 );
 893  
 
 894  0
                 append( sb, "proxyHost", 2 );
 895  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 896  0
                 append( sb, "", 0 );
 897  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 898  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 899  0
                 append( sb, "", 0 );
 900  
 
 901  0
                 append( sb, "proxyPort", 2 );
 902  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 903  0
                 append( sb, "", 0 );
 904  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 905  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 906  0
                 append( sb, "", 0 );
 907  
 
 908  0
                 append( sb, "quiet (Default: false)", 2 );
 909  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 910  0
                 append( sb, "Expression: ${quiet}", 3 );
 911  0
                 append( sb, "", 0 );
 912  
 
 913  0
                 append( sb, "remoteRepositories", 2 );
 914  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 915  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 916  0
                 append( sb, "", 0 );
 917  
 
 918  0
                 append( sb, "resourcesArtifacts", 2 );
 919  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 920  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 921  0
                 append( sb, "", 0 );
 922  
 
 923  0
                 append( sb, "serialwarn (Default: false)", 2 );
 924  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 925  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 926  0
                 append( sb, "", 0 );
 927  
 
 928  0
                 append( sb, "show (Default: protected)", 2 );
 929  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 930  0
                 append( sb, "Expression: ${show}", 3 );
 931  0
                 append( sb, "", 0 );
 932  
 
 933  0
                 append( sb, "skip (Default: false)", 2 );
 934  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 935  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 936  0
                 append( sb, "", 0 );
 937  
 
 938  0
                 append( sb, "source", 2 );
 939  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 940  0
                 append( sb, "Expression: ${source}", 3 );
 941  0
                 append( sb, "", 0 );
 942  
 
 943  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 944  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 945  0
                 append( sb, "", 0 );
 946  
 
 947  0
                 append( sb, "sourcepath", 2 );
 948  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 949  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 950  0
                 append( sb, "", 0 );
 951  
 
 952  0
                 append( sb, "sourcetab", 2 );
 953  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 954  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 955  0
                 append( sb, "", 0 );
 956  
 
 957  0
                 append( sb, "splitindex (Default: false)", 2 );
 958  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 959  0
                 append( sb, "Expression: ${splitindex}", 3 );
 960  0
                 append( sb, "", 0 );
 961  
 
 962  0
                 append( sb, "stylesheet (Default: java)", 2 );
 963  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 964  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 965  0
                 append( sb, "", 0 );
 966  
 
 967  0
                 append( sb, "stylesheetfile", 2 );
 968  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 969  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 970  0
                 append( sb, "", 0 );
 971  
 
 972  0
                 append( sb, "subpackages", 2 );
 973  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 974  0
                 append( sb, "Expression: ${subpackages}", 3 );
 975  0
                 append( sb, "", 0 );
 976  
 
 977  0
                 append( sb, "taglet", 2 );
 978  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 979  0
                 append( sb, "Expression: ${taglet}", 3 );
 980  0
                 append( sb, "", 0 );
 981  
 
 982  0
                 append( sb, "tagletArtifact", 2 );
 983  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 984  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 985  0
                 append( sb, "", 0 );
 986  
 
 987  0
                 append( sb, "tagletArtifacts", 2 );
 988  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 989  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 990  0
                 append( sb, "", 0 );
 991  
 
 992  0
                 append( sb, "tagletpath", 2 );
 993  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 994  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 995  0
                 append( sb, "", 0 );
 996  
 
 997  0
                 append( sb, "taglets", 2 );
 998  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 999  0
                 append( sb, "Expression: ${taglets}", 3 );
 1000  0
                 append( sb, "", 0 );
 1001  
 
 1002  0
                 append( sb, "tags", 2 );
 1003  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 1004  0
                 append( sb, "Expression: ${tags}", 3 );
 1005  0
                 append( sb, "", 0 );
 1006  
 
 1007  0
                 append( sb, "top", 2 );
 1008  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1009  0
                 append( sb, "Expression: ${top}", 3 );
 1010  0
                 append( sb, "", 0 );
 1011  
 
 1012  0
                 append( sb, "use (Default: true)", 2 );
 1013  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1014  0
                 append( sb, "Expression: ${use}", 3 );
 1015  0
                 append( sb, "", 0 );
 1016  
 
 1017  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 1018  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 1019  0
                 append( sb, "", 0 );
 1020  
 
 1021  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1022  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 1023  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 1024  0
                 append( sb, "", 0 );
 1025  
 
 1026  0
                 append( sb, "validateLinks (Default: false)", 2 );
 1027  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 1028  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 1029  0
                 append( sb, "", 0 );
 1030  
 
 1031  0
                 append( sb, "verbose (Default: false)", 2 );
 1032  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1033  0
                 append( sb, "Expression: ${verbose}", 3 );
 1034  0
                 append( sb, "", 0 );
 1035  
 
 1036  0
                 append( sb, "version (Default: true)", 2 );
 1037  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1038  0
                 append( sb, "Expression: ${version}", 3 );
 1039  0
                 append( sb, "", 0 );
 1040  
 
 1041  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1042  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1043  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 1044  0
                 append( sb, "", 0 );
 1045  
             }
 1046  
         }
 1047  
 
 1048  0
         if ( goal == null || goal.length() <= 0 || "fix".equals( goal ) )
 1049  
         {
 1050  0
             append( sb, "javadoc:fix", 0 );
 1051  0
             append( sb, "Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.", 1 );
 1052  0
             append( sb, "", 0 );
 1053  0
             if ( detail )
 1054  
             {
 1055  0
                 append( sb, "Available parameters:", 1 );
 1056  0
                 append( sb, "", 0 );
 1057  
 
 1058  0
                 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
 1059  0
                 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
 1060  0
                 append( sb, "Expression: ${comparisonVersion}", 3 );
 1061  0
                 append( sb, "", 0 );
 1062  
 
 1063  0
                 append( sb, "defaultAuthor", 2 );
 1064  0
                 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
 1065  0
                 append( sb, "Expression: ${defaultAuthor}", 3 );
 1066  0
                 append( sb, "", 0 );
 1067  
 
 1068  0
                 append( sb, "defaultSince (Default: ${project.version})", 2 );
 1069  0
                 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
 1070  0
                 append( sb, "Expression: ${defaultSince}", 3 );
 1071  0
                 append( sb, "", 0 );
 1072  
 
 1073  0
                 append( sb, "defaultVersion", 2 );
 1074  0
                 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
 1075  0
                 append( sb, "Expression: ${defaultVersion}", 3 );
 1076  0
                 append( sb, "", 0 );
 1077  
 
 1078  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1079  0
                 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
 1080  0
                 append( sb, "Expression: ${encoding}", 3 );
 1081  0
                 append( sb, "", 0 );
 1082  
 
 1083  0
                 append( sb, "excludes", 2 );
 1084  0
                 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
 1085  0
                 append( sb, "Expression: ${excludes}", 3 );
 1086  0
                 append( sb, "", 0 );
 1087  
 
 1088  0
                 append( sb, "fixClassComment (Default: true)", 2 );
 1089  0
                 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
 1090  0
                 append( sb, "Expression: ${fixClassComment}", 3 );
 1091  0
                 append( sb, "", 0 );
 1092  
 
 1093  0
                 append( sb, "fixFieldComment (Default: true)", 2 );
 1094  0
                 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
 1095  0
                 append( sb, "Expression: ${fixFieldComment}", 3 );
 1096  0
                 append( sb, "", 0 );
 1097  
 
 1098  0
                 append( sb, "fixMethodComment (Default: true)", 2 );
 1099  0
                 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
 1100  0
                 append( sb, "Expression: ${fixMethodComment}", 3 );
 1101  0
                 append( sb, "", 0 );
 1102  
 
 1103  0
                 append( sb, "fixTags (Default: all)", 2 );
 1104  0
                 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n", 3 );
 1105  0
                 append( sb, "Expression: ${fixTags}", 3 );
 1106  0
                 append( sb, "", 0 );
 1107  
 
 1108  0
                 append( sb, "force", 2 );
 1109  0
                 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
 1110  0
                 append( sb, "Expression: ${force}", 3 );
 1111  0
                 append( sb, "", 0 );
 1112  
 
 1113  0
                 append( sb, "ignoreClirr (Default: false)", 2 );
 1114  0
                 append( sb, "Flag to ignore or not Clirr.", 3 );
 1115  0
                 append( sb, "Expression: ${ignoreClirr}", 3 );
 1116  0
                 append( sb, "", 0 );
 1117  
 
 1118  0
                 append( sb, "includes (Default: **/*.java)", 2 );
 1119  0
                 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
 1120  0
                 append( sb, "Expression: ${includes}", 3 );
 1121  0
                 append( sb, "", 0 );
 1122  
 
 1123  0
                 append( sb, "level (Default: protected)", 2 );
 1124  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 1125  0
                 append( sb, "Expression: ${level}", 3 );
 1126  0
                 append( sb, "", 0 );
 1127  
 
 1128  0
                 append( sb, "localRepository", 2 );
 1129  0
                 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
 1130  0
                 append( sb, "Expression: ${localRepository}", 3 );
 1131  0
                 append( sb, "", 0 );
 1132  
 
 1133  0
                 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
 1134  0
                 append( sb, "Output directory where Java classes will be rewritten.", 3 );
 1135  0
                 append( sb, "Expression: ${outputDirectory}", 3 );
 1136  0
                 append( sb, "", 0 );
 1137  
             }
 1138  
         }
 1139  
 
 1140  0
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 1141  
         {
 1142  0
             append( sb, "javadoc:help", 0 );
 1143  0
             append( sb, "Display help information on maven-javadoc-plugin.\nCall\n\u00a0\u00a0mvn\u00a0javadoc:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
 1144  0
             append( sb, "", 0 );
 1145  0
             if ( detail )
 1146  
             {
 1147  0
                 append( sb, "Available parameters:", 1 );
 1148  0
                 append( sb, "", 0 );
 1149  
 
 1150  0
                 append( sb, "detail (Default: false)", 2 );
 1151  0
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 1152  0
                 append( sb, "Expression: ${detail}", 3 );
 1153  0
                 append( sb, "", 0 );
 1154  
 
 1155  0
                 append( sb, "goal", 2 );
 1156  0
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 1157  0
                 append( sb, "Expression: ${goal}", 3 );
 1158  0
                 append( sb, "", 0 );
 1159  
 
 1160  0
                 append( sb, "indentSize (Default: 2)", 2 );
 1161  0
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 1162  0
                 append( sb, "Expression: ${indentSize}", 3 );
 1163  0
                 append( sb, "", 0 );
 1164  
 
 1165  0
                 append( sb, "lineLength (Default: 80)", 2 );
 1166  0
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 1167  0
                 append( sb, "Expression: ${lineLength}", 3 );
 1168  0
                 append( sb, "", 0 );
 1169  
             }
 1170  
         }
 1171  
 
 1172  0
         if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )
 1173  
         {
 1174  0
             append( sb, "javadoc:jar", 0 );
 1175  0
             append( sb, "Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
 1176  0
             append( sb, "", 0 );
 1177  0
             if ( detail )
 1178  
             {
 1179  0
                 append( sb, "Available parameters:", 1 );
 1180  0
                 append( sb, "", 0 );
 1181  
 
 1182  0
                 append( sb, "additionalJOption", 2 );
 1183  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 1184  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 1185  0
                 append( sb, "", 0 );
 1186  
 
 1187  0
                 append( sb, "additionalparam", 2 );
 1188  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 1189  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 1190  0
                 append( sb, "", 0 );
 1191  
 
 1192  0
                 append( sb, "aggregate (Default: false)", 2 );
 1193  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1194  0
                 append( sb, "", 0 );
 1195  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1196  0
                 append( sb, "Expression: ${aggregate}", 3 );
 1197  0
                 append( sb, "", 0 );
 1198  
 
 1199  0
                 append( sb, "archive", 2 );
 1200  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 1201  0
                 append( sb, "", 0 );
 1202  
 
 1203  0
                 append( sb, "attach (Default: true)", 2 );
 1204  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 1205  0
                 append( sb, "Expression: ${attach}", 3 );
 1206  0
                 append( sb, "", 0 );
 1207  
 
 1208  0
                 append( sb, "author (Default: true)", 2 );
 1209  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1210  0
                 append( sb, "Expression: ${author}", 3 );
 1211  0
                 append( sb, "", 0 );
 1212  
 
 1213  0
                 append( sb, "bootclasspath", 2 );
 1214  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 1215  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 1216  0
                 append( sb, "", 0 );
 1217  
 
 1218  0
                 append( sb, "bootclasspathArtifacts", 2 );
 1219  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 1220  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 1221  0
                 append( sb, "", 0 );
 1222  
 
 1223  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1224  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 1225  0
                 append( sb, "Expression: ${bottom}", 3 );
 1226  0
                 append( sb, "", 0 );
 1227  
 
 1228  0
                 append( sb, "breakiterator (Default: false)", 2 );
 1229  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1230  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 1231  0
                 append( sb, "", 0 );
 1232  
 
 1233  0
                 append( sb, "charset", 2 );
 1234  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 1235  0
                 append( sb, "Expression: ${charset}", 3 );
 1236  0
                 append( sb, "", 0 );
 1237  
 
 1238  0
                 append( sb, "debug (Default: false)", 2 );
 1239  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 1240  0
                 append( sb, "Expression: ${debug}", 3 );
 1241  0
                 append( sb, "", 0 );
 1242  
 
 1243  0
                 append( sb, "dependencySourceExcludes", 2 );
 1244  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 1245  0
                 append( sb, "", 0 );
 1246  
 
 1247  0
                 append( sb, "dependencySourceIncludes", 2 );
 1248  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 1249  0
                 append( sb, "", 0 );
 1250  
 
 1251  0
                 append( sb, "destDir", 2 );
 1252  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 1253  0
                 append( sb, "Expression: ${destDir}", 3 );
 1254  0
                 append( sb, "", 0 );
 1255  
 
 1256  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 1257  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 1258  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 1259  0
                 append( sb, "", 0 );
 1260  
 
 1261  0
                 append( sb, "detectLinks (Default: false)", 2 );
 1262  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 1263  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 1264  0
                 append( sb, "", 0 );
 1265  
 
 1266  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 1267  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 1268  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 1269  0
                 append( sb, "", 0 );
 1270  
 
 1271  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1272  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1273  0
                 append( sb, "Expression: ${docencoding}", 3 );
 1274  0
                 append( sb, "", 0 );
 1275  
 
 1276  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1277  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 1278  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 1279  0
                 append( sb, "", 0 );
 1280  
 
 1281  0
                 append( sb, "doclet", 2 );
 1282  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1283  0
                 append( sb, "Expression: ${doclet}", 3 );
 1284  0
                 append( sb, "", 0 );
 1285  
 
 1286  0
                 append( sb, "docletArtifact", 2 );
 1287  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 1288  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 1289  0
                 append( sb, "", 0 );
 1290  
 
 1291  0
                 append( sb, "docletArtifacts", 2 );
 1292  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 1293  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 1294  0
                 append( sb, "", 0 );
 1295  
 
 1296  0
                 append( sb, "docletPath", 2 );
 1297  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 1298  0
                 append( sb, "Expression: ${docletPath}", 3 );
 1299  0
                 append( sb, "", 0 );
 1300  
 
 1301  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1302  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1303  0
                 append( sb, "Expression: ${doctitle}", 3 );
 1304  0
                 append( sb, "", 0 );
 1305  
 
 1306  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1307  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 1308  0
                 append( sb, "Expression: ${encoding}", 3 );
 1309  0
                 append( sb, "", 0 );
 1310  
 
 1311  0
                 append( sb, "excludedocfilessubdir", 2 );
 1312  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 1313  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 1314  0
                 append( sb, "", 0 );
 1315  
 
 1316  0
                 append( sb, "excludePackageNames", 2 );
 1317  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 1318  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 1319  0
                 append( sb, "", 0 );
 1320  
 
 1321  0
                 append( sb, "extdirs", 2 );
 1322  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 1323  0
                 append( sb, "Expression: ${extdirs}", 3 );
 1324  0
                 append( sb, "", 0 );
 1325  
 
 1326  0
                 append( sb, "failOnError (Default: true)", 2 );
 1327  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 1328  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 1329  0
                 append( sb, "", 0 );
 1330  
 
 1331  0
                 append( sb, "finalName", 2 );
 1332  0
                 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
 1333  0
                 append( sb, "Expression: ${project.build.finalName}", 3 );
 1334  0
                 append( sb, "", 0 );
 1335  
 
 1336  0
                 append( sb, "footer", 2 );
 1337  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1338  0
                 append( sb, "Expression: ${footer}", 3 );
 1339  0
                 append( sb, "", 0 );
 1340  
 
 1341  0
                 append( sb, "groups", 2 );
 1342  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 1343  0
                 append( sb, "Expression: ${groups}", 3 );
 1344  0
                 append( sb, "", 0 );
 1345  
 
 1346  0
                 append( sb, "header", 2 );
 1347  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1348  0
                 append( sb, "Expression: ${header}", 3 );
 1349  0
                 append( sb, "", 0 );
 1350  
 
 1351  0
                 append( sb, "helpfile", 2 );
 1352  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 1353  0
                 append( sb, "Expression: ${helpfile}", 3 );
 1354  0
                 append( sb, "", 0 );
 1355  
 
 1356  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 1357  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 1358  0
                 append( sb, "", 0 );
 1359  
 
 1360  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 1361  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 1362  0
                 append( sb, "", 0 );
 1363  
 
 1364  0
                 append( sb, "jarOutputDirectory", 2 );
 1365  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 1366  0
                 append( sb, "Expression: ${project.build.directory}", 3 );
 1367  0
                 append( sb, "", 0 );
 1368  
 
 1369  0
                 append( sb, "javaApiLinks", 2 );
 1370  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 1371  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 1372  0
                 append( sb, "", 0 );
 1373  
 
 1374  0
                 append( sb, "javadocDirectory", 2 );
 1375  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 1376  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 1377  0
                 append( sb, "", 0 );
 1378  
 
 1379  0
                 append( sb, "javadocExecutable", 2 );
 1380  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 1381  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 1382  0
                 append( sb, "", 0 );
 1383  
 
 1384  0
                 append( sb, "javadocVersion", 2 );
 1385  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1386  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 1387  0
                 append( sb, "", 0 );
 1388  
 
 1389  0
                 append( sb, "keywords (Default: false)", 2 );
 1390  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 1391  0
                 append( sb, "Expression: ${keywords}", 3 );
 1392  0
                 append( sb, "", 0 );
 1393  
 
 1394  0
                 append( sb, "links", 2 );
 1395  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 1396  0
                 append( sb, "Expression: ${links}", 3 );
 1397  0
                 append( sb, "", 0 );
 1398  
 
 1399  0
                 append( sb, "linksource (Default: false)", 2 );
 1400  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 1401  0
                 append( sb, "Expression: ${linksource}", 3 );
 1402  0
                 append( sb, "", 0 );
 1403  
 
 1404  0
                 append( sb, "locale", 2 );
 1405  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1406  0
                 append( sb, "Expression: ${locale}", 3 );
 1407  0
                 append( sb, "", 0 );
 1408  
 
 1409  0
                 append( sb, "localRepository", 2 );
 1410  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1411  0
                 append( sb, "Expression: ${localRepository}", 3 );
 1412  0
                 append( sb, "", 0 );
 1413  
 
 1414  0
                 append( sb, "maxmemory", 2 );
 1415  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 1416  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 1417  0
                 append( sb, "", 0 );
 1418  
 
 1419  0
                 append( sb, "minmemory", 2 );
 1420  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 1421  0
                 append( sb, "Expression: ${minmemory}", 3 );
 1422  0
                 append( sb, "", 0 );
 1423  
 
 1424  0
                 append( sb, "nocomment (Default: false)", 2 );
 1425  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 1426  0
                 append( sb, "Expression: ${nocomment}", 3 );
 1427  0
                 append( sb, "", 0 );
 1428  
 
 1429  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 1430  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1431  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 1432  0
                 append( sb, "", 0 );
 1433  
 
 1434  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1435  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 1436  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 1437  0
                 append( sb, "", 0 );
 1438  
 
 1439  0
                 append( sb, "nohelp (Default: false)", 2 );
 1440  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 1441  0
                 append( sb, "Expression: ${nohelp}", 3 );
 1442  0
                 append( sb, "", 0 );
 1443  
 
 1444  0
                 append( sb, "noindex (Default: false)", 2 );
 1445  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1446  0
                 append( sb, "Expression: ${noindex}", 3 );
 1447  0
                 append( sb, "", 0 );
 1448  
 
 1449  0
                 append( sb, "nonavbar (Default: false)", 2 );
 1450  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1451  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 1452  0
                 append( sb, "", 0 );
 1453  
 
 1454  0
                 append( sb, "nooverview (Default: false)", 2 );
 1455  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 1456  0
                 append( sb, "Expression: ${nooverview}", 3 );
 1457  0
                 append( sb, "", 0 );
 1458  
 
 1459  0
                 append( sb, "noqualifier", 2 );
 1460  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 1461  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 1462  0
                 append( sb, "", 0 );
 1463  
 
 1464  0
                 append( sb, "nosince (Default: false)", 2 );
 1465  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1466  0
                 append( sb, "Expression: ${nosince}", 3 );
 1467  0
                 append( sb, "", 0 );
 1468  
 
 1469  0
                 append( sb, "notimestamp (Default: false)", 2 );
 1470  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 1471  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 1472  0
                 append( sb, "", 0 );
 1473  
 
 1474  0
                 append( sb, "notree (Default: false)", 2 );
 1475  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1476  0
                 append( sb, "Expression: ${notree}", 3 );
 1477  0
                 append( sb, "", 0 );
 1478  
 
 1479  0
                 append( sb, "offlineLinks", 2 );
 1480  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 1481  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 1482  0
                 append( sb, "", 0 );
 1483  
 
 1484  0
                 append( sb, "old (Default: false)", 2 );
 1485  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1486  0
                 append( sb, "Expression: ${old}", 3 );
 1487  0
                 append( sb, "", 0 );
 1488  
 
 1489  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1490  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1491  0
                 append( sb, "Required: Yes", 3 );
 1492  0
                 append( sb, "Expression: ${destDir}", 3 );
 1493  0
                 append( sb, "", 0 );
 1494  
 
 1495  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1496  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 1497  0
                 append( sb, "Expression: ${overview}", 3 );
 1498  0
                 append( sb, "", 0 );
 1499  
 
 1500  0
                 append( sb, "packagesheader", 2 );
 1501  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1502  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 1503  0
                 append( sb, "", 0 );
 1504  
 
 1505  0
                 append( sb, "proxyHost", 2 );
 1506  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1507  0
                 append( sb, "", 0 );
 1508  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 1509  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 1510  0
                 append( sb, "", 0 );
 1511  
 
 1512  0
                 append( sb, "proxyPort", 2 );
 1513  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1514  0
                 append( sb, "", 0 );
 1515  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 1516  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 1517  0
                 append( sb, "", 0 );
 1518  
 
 1519  0
                 append( sb, "quiet (Default: false)", 2 );
 1520  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 1521  0
                 append( sb, "Expression: ${quiet}", 3 );
 1522  0
                 append( sb, "", 0 );
 1523  
 
 1524  0
                 append( sb, "remoteRepositories", 2 );
 1525  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1526  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 1527  0
                 append( sb, "", 0 );
 1528  
 
 1529  0
                 append( sb, "resourcesArtifacts", 2 );
 1530  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 1531  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 1532  0
                 append( sb, "", 0 );
 1533  
 
 1534  0
                 append( sb, "serialwarn (Default: false)", 2 );
 1535  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1536  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 1537  0
                 append( sb, "", 0 );
 1538  
 
 1539  0
                 append( sb, "show (Default: protected)", 2 );
 1540  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 1541  0
                 append( sb, "Expression: ${show}", 3 );
 1542  0
                 append( sb, "", 0 );
 1543  
 
 1544  0
                 append( sb, "skip (Default: false)", 2 );
 1545  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1546  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 1547  0
                 append( sb, "", 0 );
 1548  
 
 1549  0
                 append( sb, "source", 2 );
 1550  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 1551  0
                 append( sb, "Expression: ${source}", 3 );
 1552  0
                 append( sb, "", 0 );
 1553  
 
 1554  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 1555  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 1556  0
                 append( sb, "", 0 );
 1557  
 
 1558  0
                 append( sb, "sourcepath", 2 );
 1559  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 1560  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 1561  0
                 append( sb, "", 0 );
 1562  
 
 1563  0
                 append( sb, "sourcetab", 2 );
 1564  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 1565  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 1566  0
                 append( sb, "", 0 );
 1567  
 
 1568  0
                 append( sb, "splitindex (Default: false)", 2 );
 1569  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 1570  0
                 append( sb, "Expression: ${splitindex}", 3 );
 1571  0
                 append( sb, "", 0 );
 1572  
 
 1573  0
                 append( sb, "stylesheet (Default: java)", 2 );
 1574  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 1575  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 1576  0
                 append( sb, "", 0 );
 1577  
 
 1578  0
                 append( sb, "stylesheetfile", 2 );
 1579  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 1580  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 1581  0
                 append( sb, "", 0 );
 1582  
 
 1583  0
                 append( sb, "subpackages", 2 );
 1584  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 1585  0
                 append( sb, "Expression: ${subpackages}", 3 );
 1586  0
                 append( sb, "", 0 );
 1587  
 
 1588  0
                 append( sb, "taglet", 2 );
 1589  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 1590  0
                 append( sb, "Expression: ${taglet}", 3 );
 1591  0
                 append( sb, "", 0 );
 1592  
 
 1593  0
                 append( sb, "tagletArtifact", 2 );
 1594  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 1595  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 1596  0
                 append( sb, "", 0 );
 1597  
 
 1598  0
                 append( sb, "tagletArtifacts", 2 );
 1599  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 1600  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 1601  0
                 append( sb, "", 0 );
 1602  
 
 1603  0
                 append( sb, "tagletpath", 2 );
 1604  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 1605  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 1606  0
                 append( sb, "", 0 );
 1607  
 
 1608  0
                 append( sb, "taglets", 2 );
 1609  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 1610  0
                 append( sb, "Expression: ${taglets}", 3 );
 1611  0
                 append( sb, "", 0 );
 1612  
 
 1613  0
                 append( sb, "tags", 2 );
 1614  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 1615  0
                 append( sb, "Expression: ${tags}", 3 );
 1616  0
                 append( sb, "", 0 );
 1617  
 
 1618  0
                 append( sb, "top", 2 );
 1619  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1620  0
                 append( sb, "Expression: ${top}", 3 );
 1621  0
                 append( sb, "", 0 );
 1622  
 
 1623  0
                 append( sb, "use (Default: true)", 2 );
 1624  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1625  0
                 append( sb, "Expression: ${use}", 3 );
 1626  0
                 append( sb, "", 0 );
 1627  
 
 1628  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 1629  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 1630  0
                 append( sb, "", 0 );
 1631  
 
 1632  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1633  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 1634  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 1635  0
                 append( sb, "", 0 );
 1636  
 
 1637  0
                 append( sb, "validateLinks (Default: false)", 2 );
 1638  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 1639  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 1640  0
                 append( sb, "", 0 );
 1641  
 
 1642  0
                 append( sb, "verbose (Default: false)", 2 );
 1643  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1644  0
                 append( sb, "Expression: ${verbose}", 3 );
 1645  0
                 append( sb, "", 0 );
 1646  
 
 1647  0
                 append( sb, "version (Default: true)", 2 );
 1648  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1649  0
                 append( sb, "Expression: ${version}", 3 );
 1650  0
                 append( sb, "", 0 );
 1651  
 
 1652  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1653  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1654  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 1655  0
                 append( sb, "", 0 );
 1656  
             }
 1657  
         }
 1658  
 
 1659  0
         if ( goal == null || goal.length() <= 0 || "javadoc".equals( goal ) )
 1660  
         {
 1661  0
             append( sb, "javadoc:javadoc", 0 );
 1662  0
             append( sb, "Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.", 1 );
 1663  0
             append( sb, "", 0 );
 1664  0
             if ( detail )
 1665  
             {
 1666  0
                 append( sb, "Available parameters:", 1 );
 1667  0
                 append( sb, "", 0 );
 1668  
 
 1669  0
                 append( sb, "additionalJOption", 2 );
 1670  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 1671  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 1672  0
                 append( sb, "", 0 );
 1673  
 
 1674  0
                 append( sb, "additionalparam", 2 );
 1675  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 1676  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 1677  0
                 append( sb, "", 0 );
 1678  
 
 1679  0
                 append( sb, "aggregate (Default: false)", 2 );
 1680  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1681  0
                 append( sb, "", 0 );
 1682  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1683  0
                 append( sb, "Expression: ${aggregate}", 3 );
 1684  0
                 append( sb, "", 0 );
 1685  
 
 1686  0
                 append( sb, "author (Default: true)", 2 );
 1687  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1688  0
                 append( sb, "Expression: ${author}", 3 );
 1689  0
                 append( sb, "", 0 );
 1690  
 
 1691  0
                 append( sb, "bootclasspath", 2 );
 1692  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 1693  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 1694  0
                 append( sb, "", 0 );
 1695  
 
 1696  0
                 append( sb, "bootclasspathArtifacts", 2 );
 1697  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 1698  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 1699  0
                 append( sb, "", 0 );
 1700  
 
 1701  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1702  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 1703  0
                 append( sb, "Expression: ${bottom}", 3 );
 1704  0
                 append( sb, "", 0 );
 1705  
 
 1706  0
                 append( sb, "breakiterator (Default: false)", 2 );
 1707  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1708  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 1709  0
                 append( sb, "", 0 );
 1710  
 
 1711  0
                 append( sb, "charset", 2 );
 1712  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 1713  0
                 append( sb, "Expression: ${charset}", 3 );
 1714  0
                 append( sb, "", 0 );
 1715  
 
 1716  0
                 append( sb, "debug (Default: false)", 2 );
 1717  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 1718  0
                 append( sb, "Expression: ${debug}", 3 );
 1719  0
                 append( sb, "", 0 );
 1720  
 
 1721  0
                 append( sb, "dependencySourceExcludes", 2 );
 1722  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 1723  0
                 append( sb, "", 0 );
 1724  
 
 1725  0
                 append( sb, "dependencySourceIncludes", 2 );
 1726  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 1727  0
                 append( sb, "", 0 );
 1728  
 
 1729  0
                 append( sb, "description", 2 );
 1730  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 1731  0
                 append( sb, "Expression: ${description}", 3 );
 1732  0
                 append( sb, "", 0 );
 1733  
 
 1734  0
                 append( sb, "destDir (Default: apidocs)", 2 );
 1735  0
                 append( sb, "The name of the destination directory.\n", 3 );
 1736  0
                 append( sb, "Expression: ${destDir}", 3 );
 1737  0
                 append( sb, "", 0 );
 1738  
 
 1739  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 1740  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 1741  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 1742  0
                 append( sb, "", 0 );
 1743  
 
 1744  0
                 append( sb, "detectLinks (Default: false)", 2 );
 1745  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 1746  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 1747  0
                 append( sb, "", 0 );
 1748  
 
 1749  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 1750  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 1751  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 1752  0
                 append( sb, "", 0 );
 1753  
 
 1754  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1755  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1756  0
                 append( sb, "Expression: ${docencoding}", 3 );
 1757  0
                 append( sb, "", 0 );
 1758  
 
 1759  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1760  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 1761  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 1762  0
                 append( sb, "", 0 );
 1763  
 
 1764  0
                 append( sb, "doclet", 2 );
 1765  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1766  0
                 append( sb, "Expression: ${doclet}", 3 );
 1767  0
                 append( sb, "", 0 );
 1768  
 
 1769  0
                 append( sb, "docletArtifact", 2 );
 1770  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 1771  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 1772  0
                 append( sb, "", 0 );
 1773  
 
 1774  0
                 append( sb, "docletArtifacts", 2 );
 1775  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 1776  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 1777  0
                 append( sb, "", 0 );
 1778  
 
 1779  0
                 append( sb, "docletPath", 2 );
 1780  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 1781  0
                 append( sb, "Expression: ${docletPath}", 3 );
 1782  0
                 append( sb, "", 0 );
 1783  
 
 1784  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1785  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1786  0
                 append( sb, "Expression: ${doctitle}", 3 );
 1787  0
                 append( sb, "", 0 );
 1788  
 
 1789  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1790  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 1791  0
                 append( sb, "Expression: ${encoding}", 3 );
 1792  0
                 append( sb, "", 0 );
 1793  
 
 1794  0
                 append( sb, "excludedocfilessubdir", 2 );
 1795  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 1796  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 1797  0
                 append( sb, "", 0 );
 1798  
 
 1799  0
                 append( sb, "excludePackageNames", 2 );
 1800  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 1801  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 1802  0
                 append( sb, "", 0 );
 1803  
 
 1804  0
                 append( sb, "extdirs", 2 );
 1805  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 1806  0
                 append( sb, "Expression: ${extdirs}", 3 );
 1807  0
                 append( sb, "", 0 );
 1808  
 
 1809  0
                 append( sb, "failOnError (Default: true)", 2 );
 1810  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 1811  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 1812  0
                 append( sb, "", 0 );
 1813  
 
 1814  0
                 append( sb, "footer", 2 );
 1815  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1816  0
                 append( sb, "Expression: ${footer}", 3 );
 1817  0
                 append( sb, "", 0 );
 1818  
 
 1819  0
                 append( sb, "groups", 2 );
 1820  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 1821  0
                 append( sb, "Expression: ${groups}", 3 );
 1822  0
                 append( sb, "", 0 );
 1823  
 
 1824  0
                 append( sb, "header", 2 );
 1825  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1826  0
                 append( sb, "Expression: ${header}", 3 );
 1827  0
                 append( sb, "", 0 );
 1828  
 
 1829  0
                 append( sb, "helpfile", 2 );
 1830  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 1831  0
                 append( sb, "Expression: ${helpfile}", 3 );
 1832  0
                 append( sb, "", 0 );
 1833  
 
 1834  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 1835  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 1836  0
                 append( sb, "", 0 );
 1837  
 
 1838  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 1839  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 1840  0
                 append( sb, "", 0 );
 1841  
 
 1842  0
                 append( sb, "javaApiLinks", 2 );
 1843  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 1844  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 1845  0
                 append( sb, "", 0 );
 1846  
 
 1847  0
                 append( sb, "javadocDirectory", 2 );
 1848  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 1849  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 1850  0
                 append( sb, "", 0 );
 1851  
 
 1852  0
                 append( sb, "javadocExecutable", 2 );
 1853  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 1854  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 1855  0
                 append( sb, "", 0 );
 1856  
 
 1857  0
                 append( sb, "javadocVersion", 2 );
 1858  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1859  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 1860  0
                 append( sb, "", 0 );
 1861  
 
 1862  0
                 append( sb, "keywords (Default: false)", 2 );
 1863  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 1864  0
                 append( sb, "Expression: ${keywords}", 3 );
 1865  0
                 append( sb, "", 0 );
 1866  
 
 1867  0
                 append( sb, "links", 2 );
 1868  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 1869  0
                 append( sb, "Expression: ${links}", 3 );
 1870  0
                 append( sb, "", 0 );
 1871  
 
 1872  0
                 append( sb, "linksource (Default: false)", 2 );
 1873  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 1874  0
                 append( sb, "Expression: ${linksource}", 3 );
 1875  0
                 append( sb, "", 0 );
 1876  
 
 1877  0
                 append( sb, "locale", 2 );
 1878  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1879  0
                 append( sb, "Expression: ${locale}", 3 );
 1880  0
                 append( sb, "", 0 );
 1881  
 
 1882  0
                 append( sb, "localRepository", 2 );
 1883  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1884  0
                 append( sb, "Expression: ${localRepository}", 3 );
 1885  0
                 append( sb, "", 0 );
 1886  
 
 1887  0
                 append( sb, "maxmemory", 2 );
 1888  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 1889  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 1890  0
                 append( sb, "", 0 );
 1891  
 
 1892  0
                 append( sb, "minmemory", 2 );
 1893  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 1894  0
                 append( sb, "Expression: ${minmemory}", 3 );
 1895  0
                 append( sb, "", 0 );
 1896  
 
 1897  0
                 append( sb, "name", 2 );
 1898  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 1899  0
                 append( sb, "Expression: ${name}", 3 );
 1900  0
                 append( sb, "", 0 );
 1901  
 
 1902  0
                 append( sb, "nocomment (Default: false)", 2 );
 1903  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 1904  0
                 append( sb, "Expression: ${nocomment}", 3 );
 1905  0
                 append( sb, "", 0 );
 1906  
 
 1907  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 1908  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1909  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 1910  0
                 append( sb, "", 0 );
 1911  
 
 1912  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1913  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 1914  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 1915  0
                 append( sb, "", 0 );
 1916  
 
 1917  0
                 append( sb, "nohelp (Default: false)", 2 );
 1918  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 1919  0
                 append( sb, "Expression: ${nohelp}", 3 );
 1920  0
                 append( sb, "", 0 );
 1921  
 
 1922  0
                 append( sb, "noindex (Default: false)", 2 );
 1923  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1924  0
                 append( sb, "Expression: ${noindex}", 3 );
 1925  0
                 append( sb, "", 0 );
 1926  
 
 1927  0
                 append( sb, "nonavbar (Default: false)", 2 );
 1928  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1929  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 1930  0
                 append( sb, "", 0 );
 1931  
 
 1932  0
                 append( sb, "nooverview (Default: false)", 2 );
 1933  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 1934  0
                 append( sb, "Expression: ${nooverview}", 3 );
 1935  0
                 append( sb, "", 0 );
 1936  
 
 1937  0
                 append( sb, "noqualifier", 2 );
 1938  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 1939  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 1940  0
                 append( sb, "", 0 );
 1941  
 
 1942  0
                 append( sb, "nosince (Default: false)", 2 );
 1943  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1944  0
                 append( sb, "Expression: ${nosince}", 3 );
 1945  0
                 append( sb, "", 0 );
 1946  
 
 1947  0
                 append( sb, "notimestamp (Default: false)", 2 );
 1948  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 1949  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 1950  0
                 append( sb, "", 0 );
 1951  
 
 1952  0
                 append( sb, "notree (Default: false)", 2 );
 1953  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1954  0
                 append( sb, "Expression: ${notree}", 3 );
 1955  0
                 append( sb, "", 0 );
 1956  
 
 1957  0
                 append( sb, "offlineLinks", 2 );
 1958  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 1959  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 1960  0
                 append( sb, "", 0 );
 1961  
 
 1962  0
                 append( sb, "old (Default: false)", 2 );
 1963  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1964  0
                 append( sb, "Expression: ${old}", 3 );
 1965  0
                 append( sb, "", 0 );
 1966  
 
 1967  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1968  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1969  0
                 append( sb, "Required: Yes", 3 );
 1970  0
                 append( sb, "Expression: ${destDir}", 3 );
 1971  0
                 append( sb, "", 0 );
 1972  
 
 1973  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1974  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 1975  0
                 append( sb, "Expression: ${overview}", 3 );
 1976  0
                 append( sb, "", 0 );
 1977  
 
 1978  0
                 append( sb, "packagesheader", 2 );
 1979  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1980  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 1981  0
                 append( sb, "", 0 );
 1982  
 
 1983  0
                 append( sb, "proxyHost", 2 );
 1984  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1985  0
                 append( sb, "", 0 );
 1986  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 1987  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 1988  0
                 append( sb, "", 0 );
 1989  
 
 1990  0
                 append( sb, "proxyPort", 2 );
 1991  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1992  0
                 append( sb, "", 0 );
 1993  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 1994  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 1995  0
                 append( sb, "", 0 );
 1996  
 
 1997  0
                 append( sb, "quiet (Default: false)", 2 );
 1998  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 1999  0
                 append( sb, "Expression: ${quiet}", 3 );
 2000  0
                 append( sb, "", 0 );
 2001  
 
 2002  0
                 append( sb, "remoteRepositories", 2 );
 2003  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2004  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 2005  0
                 append( sb, "", 0 );
 2006  
 
 2007  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
 2008  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 2009  0
                 append( sb, "Required: Yes", 3 );
 2010  0
                 append( sb, "Expression: ${reportOutputDirectory}", 3 );
 2011  0
                 append( sb, "", 0 );
 2012  
 
 2013  0
                 append( sb, "resourcesArtifacts", 2 );
 2014  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 2015  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 2016  0
                 append( sb, "", 0 );
 2017  
 
 2018  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2019  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2020  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 2021  0
                 append( sb, "", 0 );
 2022  
 
 2023  0
                 append( sb, "show (Default: protected)", 2 );
 2024  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 2025  0
                 append( sb, "Expression: ${show}", 3 );
 2026  0
                 append( sb, "", 0 );
 2027  
 
 2028  0
                 append( sb, "skip (Default: false)", 2 );
 2029  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2030  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 2031  0
                 append( sb, "", 0 );
 2032  
 
 2033  0
                 append( sb, "source", 2 );
 2034  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 2035  0
                 append( sb, "Expression: ${source}", 3 );
 2036  0
                 append( sb, "", 0 );
 2037  
 
 2038  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2039  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2040  0
                 append( sb, "", 0 );
 2041  
 
 2042  0
                 append( sb, "sourcepath", 2 );
 2043  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 2044  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 2045  0
                 append( sb, "", 0 );
 2046  
 
 2047  0
                 append( sb, "sourcetab", 2 );
 2048  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 2049  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 2050  0
                 append( sb, "", 0 );
 2051  
 
 2052  0
                 append( sb, "splitindex (Default: false)", 2 );
 2053  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 2054  0
                 append( sb, "Expression: ${splitindex}", 3 );
 2055  0
                 append( sb, "", 0 );
 2056  
 
 2057  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2058  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 2059  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 2060  0
                 append( sb, "", 0 );
 2061  
 
 2062  0
                 append( sb, "stylesheetfile", 2 );
 2063  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 2064  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 2065  0
                 append( sb, "", 0 );
 2066  
 
 2067  0
                 append( sb, "subpackages", 2 );
 2068  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 2069  0
                 append( sb, "Expression: ${subpackages}", 3 );
 2070  0
                 append( sb, "", 0 );
 2071  
 
 2072  0
                 append( sb, "taglet", 2 );
 2073  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 2074  0
                 append( sb, "Expression: ${taglet}", 3 );
 2075  0
                 append( sb, "", 0 );
 2076  
 
 2077  0
                 append( sb, "tagletArtifact", 2 );
 2078  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 2079  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 2080  0
                 append( sb, "", 0 );
 2081  
 
 2082  0
                 append( sb, "tagletArtifacts", 2 );
 2083  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 2084  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 2085  0
                 append( sb, "", 0 );
 2086  
 
 2087  0
                 append( sb, "tagletpath", 2 );
 2088  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 2089  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 2090  0
                 append( sb, "", 0 );
 2091  
 
 2092  0
                 append( sb, "taglets", 2 );
 2093  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 2094  0
                 append( sb, "Expression: ${taglets}", 3 );
 2095  0
                 append( sb, "", 0 );
 2096  
 
 2097  0
                 append( sb, "tags", 2 );
 2098  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 2099  0
                 append( sb, "Expression: ${tags}", 3 );
 2100  0
                 append( sb, "", 0 );
 2101  
 
 2102  0
                 append( sb, "top", 2 );
 2103  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2104  0
                 append( sb, "Expression: ${top}", 3 );
 2105  0
                 append( sb, "", 0 );
 2106  
 
 2107  0
                 append( sb, "use (Default: true)", 2 );
 2108  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2109  0
                 append( sb, "Expression: ${use}", 3 );
 2110  0
                 append( sb, "", 0 );
 2111  
 
 2112  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2113  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 2114  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 2115  0
                 append( sb, "", 0 );
 2116  
 
 2117  0
                 append( sb, "validateLinks (Default: false)", 2 );
 2118  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 2119  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 2120  0
                 append( sb, "", 0 );
 2121  
 
 2122  0
                 append( sb, "verbose (Default: false)", 2 );
 2123  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2124  0
                 append( sb, "Expression: ${verbose}", 3 );
 2125  0
                 append( sb, "", 0 );
 2126  
 
 2127  0
                 append( sb, "version (Default: true)", 2 );
 2128  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2129  0
                 append( sb, "Expression: ${version}", 3 );
 2130  0
                 append( sb, "", 0 );
 2131  
 
 2132  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2133  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2134  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 2135  0
                 append( sb, "", 0 );
 2136  
             }
 2137  
         }
 2138  
 
 2139  0
         if ( goal == null || goal.length() <= 0 || "resource-bundle".equals( goal ) )
 2140  
         {
 2141  0
             append( sb, "javadoc:resource-bundle", 0 );
 2142  0
             append( sb, "Bundle AbstractJavadocMojo.javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
 2143  0
             append( sb, "", 0 );
 2144  0
             if ( detail )
 2145  
             {
 2146  0
                 append( sb, "Available parameters:", 1 );
 2147  0
                 append( sb, "", 0 );
 2148  
 
 2149  0
                 append( sb, "additionalJOption", 2 );
 2150  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 2151  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 2152  0
                 append( sb, "", 0 );
 2153  
 
 2154  0
                 append( sb, "additionalparam", 2 );
 2155  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 2156  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 2157  0
                 append( sb, "", 0 );
 2158  
 
 2159  0
                 append( sb, "aggregate (Default: false)", 2 );
 2160  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 2161  0
                 append( sb, "", 0 );
 2162  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 2163  0
                 append( sb, "Expression: ${aggregate}", 3 );
 2164  0
                 append( sb, "", 0 );
 2165  
 
 2166  0
                 append( sb, "author (Default: true)", 2 );
 2167  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 2168  0
                 append( sb, "Expression: ${author}", 3 );
 2169  0
                 append( sb, "", 0 );
 2170  
 
 2171  0
                 append( sb, "bootclasspath", 2 );
 2172  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 2173  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 2174  0
                 append( sb, "", 0 );
 2175  
 
 2176  0
                 append( sb, "bootclasspathArtifacts", 2 );
 2177  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 2178  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 2179  0
                 append( sb, "", 0 );
 2180  
 
 2181  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 2182  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 2183  0
                 append( sb, "Expression: ${bottom}", 3 );
 2184  0
                 append( sb, "", 0 );
 2185  
 
 2186  0
                 append( sb, "breakiterator (Default: false)", 2 );
 2187  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 2188  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 2189  0
                 append( sb, "", 0 );
 2190  
 
 2191  0
                 append( sb, "charset", 2 );
 2192  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 2193  0
                 append( sb, "Expression: ${charset}", 3 );
 2194  0
                 append( sb, "", 0 );
 2195  
 
 2196  0
                 append( sb, "debug (Default: false)", 2 );
 2197  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 2198  0
                 append( sb, "Expression: ${debug}", 3 );
 2199  0
                 append( sb, "", 0 );
 2200  
 
 2201  0
                 append( sb, "dependencySourceExcludes", 2 );
 2202  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 2203  0
                 append( sb, "", 0 );
 2204  
 
 2205  0
                 append( sb, "dependencySourceIncludes", 2 );
 2206  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 2207  0
                 append( sb, "", 0 );
 2208  
 
 2209  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 2210  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 2211  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 2212  0
                 append( sb, "", 0 );
 2213  
 
 2214  0
                 append( sb, "detectLinks (Default: false)", 2 );
 2215  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 2216  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 2217  0
                 append( sb, "", 0 );
 2218  
 
 2219  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 2220  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 2221  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 2222  0
                 append( sb, "", 0 );
 2223  
 
 2224  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 2225  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 2226  0
                 append( sb, "Expression: ${docencoding}", 3 );
 2227  0
                 append( sb, "", 0 );
 2228  
 
 2229  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 2230  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 2231  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 2232  0
                 append( sb, "", 0 );
 2233  
 
 2234  0
                 append( sb, "doclet", 2 );
 2235  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 2236  0
                 append( sb, "Expression: ${doclet}", 3 );
 2237  0
                 append( sb, "", 0 );
 2238  
 
 2239  0
                 append( sb, "docletArtifact", 2 );
 2240  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 2241  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 2242  0
                 append( sb, "", 0 );
 2243  
 
 2244  0
                 append( sb, "docletArtifacts", 2 );
 2245  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 2246  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 2247  0
                 append( sb, "", 0 );
 2248  
 
 2249  0
                 append( sb, "docletPath", 2 );
 2250  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 2251  0
                 append( sb, "Expression: ${docletPath}", 3 );
 2252  0
                 append( sb, "", 0 );
 2253  
 
 2254  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 2255  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2256  0
                 append( sb, "Expression: ${doctitle}", 3 );
 2257  0
                 append( sb, "", 0 );
 2258  
 
 2259  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2260  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 2261  0
                 append( sb, "Expression: ${encoding}", 3 );
 2262  0
                 append( sb, "", 0 );
 2263  
 
 2264  0
                 append( sb, "excludedocfilessubdir", 2 );
 2265  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 2266  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 2267  0
                 append( sb, "", 0 );
 2268  
 
 2269  0
                 append( sb, "excludePackageNames", 2 );
 2270  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 2271  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 2272  0
                 append( sb, "", 0 );
 2273  
 
 2274  0
                 append( sb, "extdirs", 2 );
 2275  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 2276  0
                 append( sb, "Expression: ${extdirs}", 3 );
 2277  0
                 append( sb, "", 0 );
 2278  
 
 2279  0
                 append( sb, "failOnError (Default: true)", 2 );
 2280  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 2281  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 2282  0
                 append( sb, "", 0 );
 2283  
 
 2284  0
                 append( sb, "footer", 2 );
 2285  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 2286  0
                 append( sb, "Expression: ${footer}", 3 );
 2287  0
                 append( sb, "", 0 );
 2288  
 
 2289  0
                 append( sb, "groups", 2 );
 2290  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 2291  0
                 append( sb, "Expression: ${groups}", 3 );
 2292  0
                 append( sb, "", 0 );
 2293  
 
 2294  0
                 append( sb, "header", 2 );
 2295  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 2296  0
                 append( sb, "Expression: ${header}", 3 );
 2297  0
                 append( sb, "", 0 );
 2298  
 
 2299  0
                 append( sb, "helpfile", 2 );
 2300  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 2301  0
                 append( sb, "Expression: ${helpfile}", 3 );
 2302  0
                 append( sb, "", 0 );
 2303  
 
 2304  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 2305  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 2306  0
                 append( sb, "", 0 );
 2307  
 
 2308  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 2309  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 2310  0
                 append( sb, "", 0 );
 2311  
 
 2312  0
                 append( sb, "javaApiLinks", 2 );
 2313  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 2314  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 2315  0
                 append( sb, "", 0 );
 2316  
 
 2317  0
                 append( sb, "javadocDirectory", 2 );
 2318  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 2319  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 2320  0
                 append( sb, "", 0 );
 2321  
 
 2322  0
                 append( sb, "javadocExecutable", 2 );
 2323  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 2324  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 2325  0
                 append( sb, "", 0 );
 2326  
 
 2327  0
                 append( sb, "javadocVersion", 2 );
 2328  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 2329  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 2330  0
                 append( sb, "", 0 );
 2331  
 
 2332  0
                 append( sb, "keywords (Default: false)", 2 );
 2333  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 2334  0
                 append( sb, "Expression: ${keywords}", 3 );
 2335  0
                 append( sb, "", 0 );
 2336  
 
 2337  0
                 append( sb, "links", 2 );
 2338  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 2339  0
                 append( sb, "Expression: ${links}", 3 );
 2340  0
                 append( sb, "", 0 );
 2341  
 
 2342  0
                 append( sb, "linksource (Default: false)", 2 );
 2343  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 2344  0
                 append( sb, "Expression: ${linksource}", 3 );
 2345  0
                 append( sb, "", 0 );
 2346  
 
 2347  0
                 append( sb, "locale", 2 );
 2348  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 2349  0
                 append( sb, "Expression: ${locale}", 3 );
 2350  0
                 append( sb, "", 0 );
 2351  
 
 2352  0
                 append( sb, "localRepository", 2 );
 2353  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 2354  0
                 append( sb, "Expression: ${localRepository}", 3 );
 2355  0
                 append( sb, "", 0 );
 2356  
 
 2357  0
                 append( sb, "maxmemory", 2 );
 2358  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 2359  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 2360  0
                 append( sb, "", 0 );
 2361  
 
 2362  0
                 append( sb, "minmemory", 2 );
 2363  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 2364  0
                 append( sb, "Expression: ${minmemory}", 3 );
 2365  0
                 append( sb, "", 0 );
 2366  
 
 2367  0
                 append( sb, "nocomment (Default: false)", 2 );
 2368  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 2369  0
                 append( sb, "Expression: ${nocomment}", 3 );
 2370  0
                 append( sb, "", 0 );
 2371  
 
 2372  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 2373  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 2374  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 2375  0
                 append( sb, "", 0 );
 2376  
 
 2377  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 2378  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 2379  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 2380  0
                 append( sb, "", 0 );
 2381  
 
 2382  0
                 append( sb, "nohelp (Default: false)", 2 );
 2383  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 2384  0
                 append( sb, "Expression: ${nohelp}", 3 );
 2385  0
                 append( sb, "", 0 );
 2386  
 
 2387  0
                 append( sb, "noindex (Default: false)", 2 );
 2388  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 2389  0
                 append( sb, "Expression: ${noindex}", 3 );
 2390  0
                 append( sb, "", 0 );
 2391  
 
 2392  0
                 append( sb, "nonavbar (Default: false)", 2 );
 2393  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 2394  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 2395  0
                 append( sb, "", 0 );
 2396  
 
 2397  0
                 append( sb, "nooverview (Default: false)", 2 );
 2398  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 2399  0
                 append( sb, "Expression: ${nooverview}", 3 );
 2400  0
                 append( sb, "", 0 );
 2401  
 
 2402  0
                 append( sb, "noqualifier", 2 );
 2403  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 2404  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 2405  0
                 append( sb, "", 0 );
 2406  
 
 2407  0
                 append( sb, "nosince (Default: false)", 2 );
 2408  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 2409  0
                 append( sb, "Expression: ${nosince}", 3 );
 2410  0
                 append( sb, "", 0 );
 2411  
 
 2412  0
                 append( sb, "notimestamp (Default: false)", 2 );
 2413  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 2414  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 2415  0
                 append( sb, "", 0 );
 2416  
 
 2417  0
                 append( sb, "notree (Default: false)", 2 );
 2418  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 2419  0
                 append( sb, "Expression: ${notree}", 3 );
 2420  0
                 append( sb, "", 0 );
 2421  
 
 2422  0
                 append( sb, "offlineLinks", 2 );
 2423  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 2424  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 2425  0
                 append( sb, "", 0 );
 2426  
 
 2427  0
                 append( sb, "old (Default: false)", 2 );
 2428  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 2429  0
                 append( sb, "Expression: ${old}", 3 );
 2430  0
                 append( sb, "", 0 );
 2431  
 
 2432  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 2433  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 2434  0
                 append( sb, "Required: Yes", 3 );
 2435  0
                 append( sb, "Expression: ${destDir}", 3 );
 2436  0
                 append( sb, "", 0 );
 2437  
 
 2438  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 2439  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 2440  0
                 append( sb, "Expression: ${overview}", 3 );
 2441  0
                 append( sb, "", 0 );
 2442  
 
 2443  0
                 append( sb, "packagesheader", 2 );
 2444  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 2445  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 2446  0
                 append( sb, "", 0 );
 2447  
 
 2448  0
                 append( sb, "proxyHost", 2 );
 2449  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 2450  0
                 append( sb, "", 0 );
 2451  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 2452  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 2453  0
                 append( sb, "", 0 );
 2454  
 
 2455  0
                 append( sb, "proxyPort", 2 );
 2456  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2457  0
                 append( sb, "", 0 );
 2458  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 2459  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 2460  0
                 append( sb, "", 0 );
 2461  
 
 2462  0
                 append( sb, "quiet (Default: false)", 2 );
 2463  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 2464  0
                 append( sb, "Expression: ${quiet}", 3 );
 2465  0
                 append( sb, "", 0 );
 2466  
 
 2467  0
                 append( sb, "remoteRepositories", 2 );
 2468  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2469  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 2470  0
                 append( sb, "", 0 );
 2471  
 
 2472  0
                 append( sb, "resourcesArtifacts", 2 );
 2473  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 2474  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 2475  0
                 append( sb, "", 0 );
 2476  
 
 2477  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2478  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2479  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 2480  0
                 append( sb, "", 0 );
 2481  
 
 2482  0
                 append( sb, "show (Default: protected)", 2 );
 2483  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 2484  0
                 append( sb, "Expression: ${show}", 3 );
 2485  0
                 append( sb, "", 0 );
 2486  
 
 2487  0
                 append( sb, "skip (Default: false)", 2 );
 2488  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2489  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 2490  0
                 append( sb, "", 0 );
 2491  
 
 2492  0
                 append( sb, "source", 2 );
 2493  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 2494  0
                 append( sb, "Expression: ${source}", 3 );
 2495  0
                 append( sb, "", 0 );
 2496  
 
 2497  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2498  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2499  0
                 append( sb, "", 0 );
 2500  
 
 2501  0
                 append( sb, "sourcepath", 2 );
 2502  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 2503  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 2504  0
                 append( sb, "", 0 );
 2505  
 
 2506  0
                 append( sb, "sourcetab", 2 );
 2507  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 2508  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 2509  0
                 append( sb, "", 0 );
 2510  
 
 2511  0
                 append( sb, "splitindex (Default: false)", 2 );
 2512  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 2513  0
                 append( sb, "Expression: ${splitindex}", 3 );
 2514  0
                 append( sb, "", 0 );
 2515  
 
 2516  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2517  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 2518  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 2519  0
                 append( sb, "", 0 );
 2520  
 
 2521  0
                 append( sb, "stylesheetfile", 2 );
 2522  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 2523  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 2524  0
                 append( sb, "", 0 );
 2525  
 
 2526  0
                 append( sb, "subpackages", 2 );
 2527  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 2528  0
                 append( sb, "Expression: ${subpackages}", 3 );
 2529  0
                 append( sb, "", 0 );
 2530  
 
 2531  0
                 append( sb, "taglet", 2 );
 2532  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 2533  0
                 append( sb, "Expression: ${taglet}", 3 );
 2534  0
                 append( sb, "", 0 );
 2535  
 
 2536  0
                 append( sb, "tagletArtifact", 2 );
 2537  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 2538  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 2539  0
                 append( sb, "", 0 );
 2540  
 
 2541  0
                 append( sb, "tagletArtifacts", 2 );
 2542  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 2543  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 2544  0
                 append( sb, "", 0 );
 2545  
 
 2546  0
                 append( sb, "tagletpath", 2 );
 2547  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 2548  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 2549  0
                 append( sb, "", 0 );
 2550  
 
 2551  0
                 append( sb, "taglets", 2 );
 2552  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 2553  0
                 append( sb, "Expression: ${taglets}", 3 );
 2554  0
                 append( sb, "", 0 );
 2555  
 
 2556  0
                 append( sb, "tags", 2 );
 2557  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 2558  0
                 append( sb, "Expression: ${tags}", 3 );
 2559  0
                 append( sb, "", 0 );
 2560  
 
 2561  0
                 append( sb, "top", 2 );
 2562  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2563  0
                 append( sb, "Expression: ${top}", 3 );
 2564  0
                 append( sb, "", 0 );
 2565  
 
 2566  0
                 append( sb, "use (Default: true)", 2 );
 2567  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2568  0
                 append( sb, "Expression: ${use}", 3 );
 2569  0
                 append( sb, "", 0 );
 2570  
 
 2571  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2572  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 2573  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 2574  0
                 append( sb, "", 0 );
 2575  
 
 2576  0
                 append( sb, "validateLinks (Default: false)", 2 );
 2577  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 2578  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 2579  0
                 append( sb, "", 0 );
 2580  
 
 2581  0
                 append( sb, "verbose (Default: false)", 2 );
 2582  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2583  0
                 append( sb, "Expression: ${verbose}", 3 );
 2584  0
                 append( sb, "", 0 );
 2585  
 
 2586  0
                 append( sb, "version (Default: true)", 2 );
 2587  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2588  0
                 append( sb, "Expression: ${version}", 3 );
 2589  0
                 append( sb, "", 0 );
 2590  
 
 2591  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2592  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2593  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 2594  0
                 append( sb, "", 0 );
 2595  
             }
 2596  
         }
 2597  
 
 2598  0
         if ( goal == null || goal.length() <= 0 || "test-aggregate".equals( goal ) )
 2599  
         {
 2600  0
             append( sb, "javadoc:test-aggregate", 0 );
 2601  0
             append( sb, "Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.", 1 );
 2602  0
             append( sb, "", 0 );
 2603  0
             if ( detail )
 2604  
             {
 2605  0
                 append( sb, "Available parameters:", 1 );
 2606  0
                 append( sb, "", 0 );
 2607  
 
 2608  0
                 append( sb, "additionalJOption", 2 );
 2609  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 2610  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 2611  0
                 append( sb, "", 0 );
 2612  
 
 2613  0
                 append( sb, "additionalparam", 2 );
 2614  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 2615  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 2616  0
                 append( sb, "", 0 );
 2617  
 
 2618  0
                 append( sb, "aggregate (Default: false)", 2 );
 2619  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 2620  0
                 append( sb, "", 0 );
 2621  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 2622  0
                 append( sb, "Expression: ${aggregate}", 3 );
 2623  0
                 append( sb, "", 0 );
 2624  
 
 2625  0
                 append( sb, "author (Default: true)", 2 );
 2626  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 2627  0
                 append( sb, "Expression: ${author}", 3 );
 2628  0
                 append( sb, "", 0 );
 2629  
 
 2630  0
                 append( sb, "bootclasspath", 2 );
 2631  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 2632  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 2633  0
                 append( sb, "", 0 );
 2634  
 
 2635  0
                 append( sb, "bootclasspathArtifacts", 2 );
 2636  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 2637  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 2638  0
                 append( sb, "", 0 );
 2639  
 
 2640  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 2641  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 2642  0
                 append( sb, "Expression: ${bottom}", 3 );
 2643  0
                 append( sb, "", 0 );
 2644  
 
 2645  0
                 append( sb, "breakiterator (Default: false)", 2 );
 2646  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 2647  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 2648  0
                 append( sb, "", 0 );
 2649  
 
 2650  0
                 append( sb, "charset", 2 );
 2651  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 2652  0
                 append( sb, "Expression: ${charset}", 3 );
 2653  0
                 append( sb, "", 0 );
 2654  
 
 2655  0
                 append( sb, "debug (Default: false)", 2 );
 2656  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 2657  0
                 append( sb, "Expression: ${debug}", 3 );
 2658  0
                 append( sb, "", 0 );
 2659  
 
 2660  0
                 append( sb, "dependencySourceExcludes", 2 );
 2661  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 2662  0
                 append( sb, "", 0 );
 2663  
 
 2664  0
                 append( sb, "dependencySourceIncludes", 2 );
 2665  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 2666  0
                 append( sb, "", 0 );
 2667  
 
 2668  0
                 append( sb, "description", 2 );
 2669  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 2670  0
                 append( sb, "Expression: ${description}", 3 );
 2671  0
                 append( sb, "", 0 );
 2672  
 
 2673  0
                 append( sb, "destDir (Default: testapidocs)", 2 );
 2674  0
                 append( sb, "The name of the destination directory.\n", 3 );
 2675  0
                 append( sb, "Expression: ${destDir}", 3 );
 2676  0
                 append( sb, "", 0 );
 2677  
 
 2678  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 2679  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 2680  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 2681  0
                 append( sb, "", 0 );
 2682  
 
 2683  0
                 append( sb, "detectLinks (Default: false)", 2 );
 2684  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 2685  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 2686  0
                 append( sb, "", 0 );
 2687  
 
 2688  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 2689  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 2690  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 2691  0
                 append( sb, "", 0 );
 2692  
 
 2693  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 2694  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 2695  0
                 append( sb, "Expression: ${docencoding}", 3 );
 2696  0
                 append( sb, "", 0 );
 2697  
 
 2698  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 2699  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 2700  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 2701  0
                 append( sb, "", 0 );
 2702  
 
 2703  0
                 append( sb, "doclet", 2 );
 2704  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 2705  0
                 append( sb, "Expression: ${doclet}", 3 );
 2706  0
                 append( sb, "", 0 );
 2707  
 
 2708  0
                 append( sb, "docletArtifact", 2 );
 2709  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 2710  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 2711  0
                 append( sb, "", 0 );
 2712  
 
 2713  0
                 append( sb, "docletArtifacts", 2 );
 2714  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 2715  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 2716  0
                 append( sb, "", 0 );
 2717  
 
 2718  0
                 append( sb, "docletPath", 2 );
 2719  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 2720  0
                 append( sb, "Expression: ${docletPath}", 3 );
 2721  0
                 append( sb, "", 0 );
 2722  
 
 2723  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 2724  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2725  0
                 append( sb, "Expression: ${doctitle}", 3 );
 2726  0
                 append( sb, "", 0 );
 2727  
 
 2728  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2729  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 2730  0
                 append( sb, "Expression: ${encoding}", 3 );
 2731  0
                 append( sb, "", 0 );
 2732  
 
 2733  0
                 append( sb, "excludedocfilessubdir", 2 );
 2734  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 2735  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 2736  0
                 append( sb, "", 0 );
 2737  
 
 2738  0
                 append( sb, "excludePackageNames", 2 );
 2739  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 2740  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 2741  0
                 append( sb, "", 0 );
 2742  
 
 2743  0
                 append( sb, "extdirs", 2 );
 2744  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 2745  0
                 append( sb, "Expression: ${extdirs}", 3 );
 2746  0
                 append( sb, "", 0 );
 2747  
 
 2748  0
                 append( sb, "failOnError (Default: true)", 2 );
 2749  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 2750  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 2751  0
                 append( sb, "", 0 );
 2752  
 
 2753  0
                 append( sb, "footer", 2 );
 2754  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 2755  0
                 append( sb, "Expression: ${footer}", 3 );
 2756  0
                 append( sb, "", 0 );
 2757  
 
 2758  0
                 append( sb, "groups", 2 );
 2759  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 2760  0
                 append( sb, "Expression: ${groups}", 3 );
 2761  0
                 append( sb, "", 0 );
 2762  
 
 2763  0
                 append( sb, "header", 2 );
 2764  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 2765  0
                 append( sb, "Expression: ${header}", 3 );
 2766  0
                 append( sb, "", 0 );
 2767  
 
 2768  0
                 append( sb, "helpfile", 2 );
 2769  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 2770  0
                 append( sb, "Expression: ${helpfile}", 3 );
 2771  0
                 append( sb, "", 0 );
 2772  
 
 2773  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 2774  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 2775  0
                 append( sb, "", 0 );
 2776  
 
 2777  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 2778  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 2779  0
                 append( sb, "", 0 );
 2780  
 
 2781  0
                 append( sb, "javaApiLinks", 2 );
 2782  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 2783  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 2784  0
                 append( sb, "", 0 );
 2785  
 
 2786  0
                 append( sb, "javadocDirectory", 2 );
 2787  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 2788  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 2789  0
                 append( sb, "", 0 );
 2790  
 
 2791  0
                 append( sb, "javadocExecutable", 2 );
 2792  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 2793  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 2794  0
                 append( sb, "", 0 );
 2795  
 
 2796  0
                 append( sb, "javadocVersion", 2 );
 2797  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 2798  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 2799  0
                 append( sb, "", 0 );
 2800  
 
 2801  0
                 append( sb, "keywords (Default: false)", 2 );
 2802  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 2803  0
                 append( sb, "Expression: ${keywords}", 3 );
 2804  0
                 append( sb, "", 0 );
 2805  
 
 2806  0
                 append( sb, "links", 2 );
 2807  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 2808  0
                 append( sb, "Expression: ${links}", 3 );
 2809  0
                 append( sb, "", 0 );
 2810  
 
 2811  0
                 append( sb, "linksource (Default: false)", 2 );
 2812  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 2813  0
                 append( sb, "Expression: ${linksource}", 3 );
 2814  0
                 append( sb, "", 0 );
 2815  
 
 2816  0
                 append( sb, "locale", 2 );
 2817  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 2818  0
                 append( sb, "Expression: ${locale}", 3 );
 2819  0
                 append( sb, "", 0 );
 2820  
 
 2821  0
                 append( sb, "localRepository", 2 );
 2822  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 2823  0
                 append( sb, "Expression: ${localRepository}", 3 );
 2824  0
                 append( sb, "", 0 );
 2825  
 
 2826  0
                 append( sb, "maxmemory", 2 );
 2827  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 2828  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 2829  0
                 append( sb, "", 0 );
 2830  
 
 2831  0
                 append( sb, "minmemory", 2 );
 2832  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 2833  0
                 append( sb, "Expression: ${minmemory}", 3 );
 2834  0
                 append( sb, "", 0 );
 2835  
 
 2836  0
                 append( sb, "name", 2 );
 2837  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 2838  0
                 append( sb, "Expression: ${name}", 3 );
 2839  0
                 append( sb, "", 0 );
 2840  
 
 2841  0
                 append( sb, "nocomment (Default: false)", 2 );
 2842  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 2843  0
                 append( sb, "Expression: ${nocomment}", 3 );
 2844  0
                 append( sb, "", 0 );
 2845  
 
 2846  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 2847  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 2848  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 2849  0
                 append( sb, "", 0 );
 2850  
 
 2851  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 2852  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 2853  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 2854  0
                 append( sb, "", 0 );
 2855  
 
 2856  0
                 append( sb, "nohelp (Default: false)", 2 );
 2857  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 2858  0
                 append( sb, "Expression: ${nohelp}", 3 );
 2859  0
                 append( sb, "", 0 );
 2860  
 
 2861  0
                 append( sb, "noindex (Default: false)", 2 );
 2862  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 2863  0
                 append( sb, "Expression: ${noindex}", 3 );
 2864  0
                 append( sb, "", 0 );
 2865  
 
 2866  0
                 append( sb, "nonavbar (Default: false)", 2 );
 2867  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 2868  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 2869  0
                 append( sb, "", 0 );
 2870  
 
 2871  0
                 append( sb, "nooverview (Default: false)", 2 );
 2872  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 2873  0
                 append( sb, "Expression: ${nooverview}", 3 );
 2874  0
                 append( sb, "", 0 );
 2875  
 
 2876  0
                 append( sb, "noqualifier", 2 );
 2877  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 2878  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 2879  0
                 append( sb, "", 0 );
 2880  
 
 2881  0
                 append( sb, "nosince (Default: false)", 2 );
 2882  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 2883  0
                 append( sb, "Expression: ${nosince}", 3 );
 2884  0
                 append( sb, "", 0 );
 2885  
 
 2886  0
                 append( sb, "notimestamp (Default: false)", 2 );
 2887  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 2888  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 2889  0
                 append( sb, "", 0 );
 2890  
 
 2891  0
                 append( sb, "notree (Default: false)", 2 );
 2892  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 2893  0
                 append( sb, "Expression: ${notree}", 3 );
 2894  0
                 append( sb, "", 0 );
 2895  
 
 2896  0
                 append( sb, "offlineLinks", 2 );
 2897  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 2898  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 2899  0
                 append( sb, "", 0 );
 2900  
 
 2901  0
                 append( sb, "old (Default: false)", 2 );
 2902  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 2903  0
                 append( sb, "Expression: ${old}", 3 );
 2904  0
                 append( sb, "", 0 );
 2905  
 
 2906  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 2907  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 2908  0
                 append( sb, "Required: Yes", 3 );
 2909  0
                 append( sb, "Expression: ${destDir}", 3 );
 2910  0
                 append( sb, "", 0 );
 2911  
 
 2912  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 2913  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 2914  0
                 append( sb, "Expression: ${overview}", 3 );
 2915  0
                 append( sb, "", 0 );
 2916  
 
 2917  0
                 append( sb, "packagesheader", 2 );
 2918  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 2919  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 2920  0
                 append( sb, "", 0 );
 2921  
 
 2922  0
                 append( sb, "proxyHost", 2 );
 2923  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 2924  0
                 append( sb, "", 0 );
 2925  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 2926  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 2927  0
                 append( sb, "", 0 );
 2928  
 
 2929  0
                 append( sb, "proxyPort", 2 );
 2930  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2931  0
                 append( sb, "", 0 );
 2932  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 2933  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 2934  0
                 append( sb, "", 0 );
 2935  
 
 2936  0
                 append( sb, "quiet (Default: false)", 2 );
 2937  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 2938  0
                 append( sb, "Expression: ${quiet}", 3 );
 2939  0
                 append( sb, "", 0 );
 2940  
 
 2941  0
                 append( sb, "remoteRepositories", 2 );
 2942  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2943  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 2944  0
                 append( sb, "", 0 );
 2945  
 
 2946  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
 2947  0
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 2948  0
                 append( sb, "Required: Yes", 3 );
 2949  0
                 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
 2950  0
                 append( sb, "", 0 );
 2951  
 
 2952  0
                 append( sb, "resourcesArtifacts", 2 );
 2953  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 2954  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 2955  0
                 append( sb, "", 0 );
 2956  
 
 2957  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2958  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2959  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 2960  0
                 append( sb, "", 0 );
 2961  
 
 2962  0
                 append( sb, "show (Default: protected)", 2 );
 2963  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 2964  0
                 append( sb, "Expression: ${show}", 3 );
 2965  0
                 append( sb, "", 0 );
 2966  
 
 2967  0
                 append( sb, "skip (Default: false)", 2 );
 2968  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2969  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 2970  0
                 append( sb, "", 0 );
 2971  
 
 2972  0
                 append( sb, "source", 2 );
 2973  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 2974  0
                 append( sb, "Expression: ${source}", 3 );
 2975  0
                 append( sb, "", 0 );
 2976  
 
 2977  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2978  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2979  0
                 append( sb, "", 0 );
 2980  
 
 2981  0
                 append( sb, "sourcepath", 2 );
 2982  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 2983  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 2984  0
                 append( sb, "", 0 );
 2985  
 
 2986  0
                 append( sb, "sourcetab", 2 );
 2987  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 2988  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 2989  0
                 append( sb, "", 0 );
 2990  
 
 2991  0
                 append( sb, "splitindex (Default: false)", 2 );
 2992  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 2993  0
                 append( sb, "Expression: ${splitindex}", 3 );
 2994  0
                 append( sb, "", 0 );
 2995  
 
 2996  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2997  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 2998  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 2999  0
                 append( sb, "", 0 );
 3000  
 
 3001  0
                 append( sb, "stylesheetfile", 2 );
 3002  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 3003  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 3004  0
                 append( sb, "", 0 );
 3005  
 
 3006  0
                 append( sb, "subpackages", 2 );
 3007  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 3008  0
                 append( sb, "Expression: ${subpackages}", 3 );
 3009  0
                 append( sb, "", 0 );
 3010  
 
 3011  0
                 append( sb, "taglet", 2 );
 3012  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 3013  0
                 append( sb, "Expression: ${taglet}", 3 );
 3014  0
                 append( sb, "", 0 );
 3015  
 
 3016  0
                 append( sb, "tagletArtifact", 2 );
 3017  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 3018  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 3019  0
                 append( sb, "", 0 );
 3020  
 
 3021  0
                 append( sb, "tagletArtifacts", 2 );
 3022  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 3023  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 3024  0
                 append( sb, "", 0 );
 3025  
 
 3026  0
                 append( sb, "tagletpath", 2 );
 3027  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 3028  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 3029  0
                 append( sb, "", 0 );
 3030  
 
 3031  0
                 append( sb, "taglets", 2 );
 3032  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 3033  0
                 append( sb, "Expression: ${taglets}", 3 );
 3034  0
                 append( sb, "", 0 );
 3035  
 
 3036  0
                 append( sb, "tags", 2 );
 3037  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 3038  0
                 append( sb, "Expression: ${tags}", 3 );
 3039  0
                 append( sb, "", 0 );
 3040  
 
 3041  0
                 append( sb, "testDescription", 2 );
 3042  0
                 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 3043  0
                 append( sb, "Expression: ${testDescription}", 3 );
 3044  0
                 append( sb, "", 0 );
 3045  
 
 3046  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3047  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3048  0
                 append( sb, "Expression: ${testDoctitle}", 3 );
 3049  0
                 append( sb, "", 0 );
 3050  
 
 3051  0
                 append( sb, "testJavadocDirectory", 2 );
 3052  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 3053  0
                 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
 3054  0
                 append( sb, "", 0 );
 3055  
 
 3056  0
                 append( sb, "testName", 2 );
 3057  0
                 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 3058  0
                 append( sb, "Expression: ${testName}", 3 );
 3059  0
                 append( sb, "", 0 );
 3060  
 
 3061  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 3062  0
                 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 3063  0
                 append( sb, "Expression: ${testOverview}", 3 );
 3064  0
                 append( sb, "", 0 );
 3065  
 
 3066  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3067  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3068  0
                 append( sb, "Expression: ${testWindowtitle}", 3 );
 3069  0
                 append( sb, "", 0 );
 3070  
 
 3071  0
                 append( sb, "top", 2 );
 3072  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 3073  0
                 append( sb, "Expression: ${top}", 3 );
 3074  0
                 append( sb, "", 0 );
 3075  
 
 3076  0
                 append( sb, "use (Default: true)", 2 );
 3077  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 3078  0
                 append( sb, "Expression: ${use}", 3 );
 3079  0
                 append( sb, "", 0 );
 3080  
 
 3081  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 3082  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 3083  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 3084  0
                 append( sb, "", 0 );
 3085  
 
 3086  0
                 append( sb, "validateLinks (Default: false)", 2 );
 3087  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 3088  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 3089  0
                 append( sb, "", 0 );
 3090  
 
 3091  0
                 append( sb, "verbose (Default: false)", 2 );
 3092  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 3093  0
                 append( sb, "Expression: ${verbose}", 3 );
 3094  0
                 append( sb, "", 0 );
 3095  
 
 3096  0
                 append( sb, "version (Default: true)", 2 );
 3097  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 3098  0
                 append( sb, "Expression: ${version}", 3 );
 3099  0
                 append( sb, "", 0 );
 3100  
 
 3101  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 3102  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3103  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 3104  0
                 append( sb, "", 0 );
 3105  
             }
 3106  
         }
 3107  
 
 3108  0
         if ( goal == null || goal.length() <= 0 || "test-aggregate-jar".equals( goal ) )
 3109  
         {
 3110  0
             append( sb, "javadoc:test-aggregate-jar", 0 );
 3111  0
             append( sb, "Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
 3112  0
             append( sb, "", 0 );
 3113  0
             if ( detail )
 3114  
             {
 3115  0
                 append( sb, "Available parameters:", 1 );
 3116  0
                 append( sb, "", 0 );
 3117  
 
 3118  0
                 append( sb, "additionalJOption", 2 );
 3119  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 3120  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 3121  0
                 append( sb, "", 0 );
 3122  
 
 3123  0
                 append( sb, "additionalparam", 2 );
 3124  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 3125  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 3126  0
                 append( sb, "", 0 );
 3127  
 
 3128  0
                 append( sb, "aggregate (Default: false)", 2 );
 3129  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 3130  0
                 append( sb, "", 0 );
 3131  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 3132  0
                 append( sb, "Expression: ${aggregate}", 3 );
 3133  0
                 append( sb, "", 0 );
 3134  
 
 3135  0
                 append( sb, "archive", 2 );
 3136  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 3137  0
                 append( sb, "", 0 );
 3138  
 
 3139  0
                 append( sb, "attach (Default: true)", 2 );
 3140  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 3141  0
                 append( sb, "Expression: ${attach}", 3 );
 3142  0
                 append( sb, "", 0 );
 3143  
 
 3144  0
                 append( sb, "author (Default: true)", 2 );
 3145  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 3146  0
                 append( sb, "Expression: ${author}", 3 );
 3147  0
                 append( sb, "", 0 );
 3148  
 
 3149  0
                 append( sb, "bootclasspath", 2 );
 3150  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 3151  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 3152  0
                 append( sb, "", 0 );
 3153  
 
 3154  0
                 append( sb, "bootclasspathArtifacts", 2 );
 3155  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 3156  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 3157  0
                 append( sb, "", 0 );
 3158  
 
 3159  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 3160  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 3161  0
                 append( sb, "Expression: ${bottom}", 3 );
 3162  0
                 append( sb, "", 0 );
 3163  
 
 3164  0
                 append( sb, "breakiterator (Default: false)", 2 );
 3165  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 3166  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 3167  0
                 append( sb, "", 0 );
 3168  
 
 3169  0
                 append( sb, "charset", 2 );
 3170  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 3171  0
                 append( sb, "Expression: ${charset}", 3 );
 3172  0
                 append( sb, "", 0 );
 3173  
 
 3174  0
                 append( sb, "debug (Default: false)", 2 );
 3175  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 3176  0
                 append( sb, "Expression: ${debug}", 3 );
 3177  0
                 append( sb, "", 0 );
 3178  
 
 3179  0
                 append( sb, "dependencySourceExcludes", 2 );
 3180  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 3181  0
                 append( sb, "", 0 );
 3182  
 
 3183  0
                 append( sb, "dependencySourceIncludes", 2 );
 3184  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 3185  0
                 append( sb, "", 0 );
 3186  
 
 3187  0
                 append( sb, "destDir", 2 );
 3188  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 3189  0
                 append( sb, "Expression: ${destDir}", 3 );
 3190  0
                 append( sb, "", 0 );
 3191  
 
 3192  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 3193  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 3194  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 3195  0
                 append( sb, "", 0 );
 3196  
 
 3197  0
                 append( sb, "detectLinks (Default: false)", 2 );
 3198  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 3199  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 3200  0
                 append( sb, "", 0 );
 3201  
 
 3202  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 3203  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 3204  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 3205  0
                 append( sb, "", 0 );
 3206  
 
 3207  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 3208  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 3209  0
                 append( sb, "Expression: ${docencoding}", 3 );
 3210  0
                 append( sb, "", 0 );
 3211  
 
 3212  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 3213  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 3214  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 3215  0
                 append( sb, "", 0 );
 3216  
 
 3217  0
                 append( sb, "doclet", 2 );
 3218  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 3219  0
                 append( sb, "Expression: ${doclet}", 3 );
 3220  0
                 append( sb, "", 0 );
 3221  
 
 3222  0
                 append( sb, "docletArtifact", 2 );
 3223  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 3224  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 3225  0
                 append( sb, "", 0 );
 3226  
 
 3227  0
                 append( sb, "docletArtifacts", 2 );
 3228  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 3229  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 3230  0
                 append( sb, "", 0 );
 3231  
 
 3232  0
                 append( sb, "docletPath", 2 );
 3233  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 3234  0
                 append( sb, "Expression: ${docletPath}", 3 );
 3235  0
                 append( sb, "", 0 );
 3236  
 
 3237  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 3238  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3239  0
                 append( sb, "Expression: ${doctitle}", 3 );
 3240  0
                 append( sb, "", 0 );
 3241  
 
 3242  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3243  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 3244  0
                 append( sb, "Expression: ${encoding}", 3 );
 3245  0
                 append( sb, "", 0 );
 3246  
 
 3247  0
                 append( sb, "excludedocfilessubdir", 2 );
 3248  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 3249  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 3250  0
                 append( sb, "", 0 );
 3251  
 
 3252  0
                 append( sb, "excludePackageNames", 2 );
 3253  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 3254  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 3255  0
                 append( sb, "", 0 );
 3256  
 
 3257  0
                 append( sb, "extdirs", 2 );
 3258  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 3259  0
                 append( sb, "Expression: ${extdirs}", 3 );
 3260  0
                 append( sb, "", 0 );
 3261  
 
 3262  0
                 append( sb, "failOnError (Default: true)", 2 );
 3263  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 3264  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 3265  0
                 append( sb, "", 0 );
 3266  
 
 3267  0
                 append( sb, "finalName", 2 );
 3268  0
                 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
 3269  0
                 append( sb, "Expression: ${project.build.finalName}", 3 );
 3270  0
                 append( sb, "", 0 );
 3271  
 
 3272  0
                 append( sb, "footer", 2 );
 3273  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 3274  0
                 append( sb, "Expression: ${footer}", 3 );
 3275  0
                 append( sb, "", 0 );
 3276  
 
 3277  0
                 append( sb, "groups", 2 );
 3278  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 3279  0
                 append( sb, "Expression: ${groups}", 3 );
 3280  0
                 append( sb, "", 0 );
 3281  
 
 3282  0
                 append( sb, "header", 2 );
 3283  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 3284  0
                 append( sb, "Expression: ${header}", 3 );
 3285  0
                 append( sb, "", 0 );
 3286  
 
 3287  0
                 append( sb, "helpfile", 2 );
 3288  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 3289  0
                 append( sb, "Expression: ${helpfile}", 3 );
 3290  0
                 append( sb, "", 0 );
 3291  
 
 3292  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 3293  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 3294  0
                 append( sb, "", 0 );
 3295  
 
 3296  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 3297  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 3298  0
                 append( sb, "", 0 );
 3299  
 
 3300  0
                 append( sb, "jarOutputDirectory", 2 );
 3301  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 3302  0
                 append( sb, "Expression: ${project.build.directory}", 3 );
 3303  0
                 append( sb, "", 0 );
 3304  
 
 3305  0
                 append( sb, "javaApiLinks", 2 );
 3306  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 3307  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 3308  0
                 append( sb, "", 0 );
 3309  
 
 3310  0
                 append( sb, "javadocDirectory", 2 );
 3311  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 3312  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 3313  0
                 append( sb, "", 0 );
 3314  
 
 3315  0
                 append( sb, "javadocExecutable", 2 );
 3316  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 3317  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 3318  0
                 append( sb, "", 0 );
 3319  
 
 3320  0
                 append( sb, "javadocVersion", 2 );
 3321  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 3322  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 3323  0
                 append( sb, "", 0 );
 3324  
 
 3325  0
                 append( sb, "keywords (Default: false)", 2 );
 3326  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 3327  0
                 append( sb, "Expression: ${keywords}", 3 );
 3328  0
                 append( sb, "", 0 );
 3329  
 
 3330  0
                 append( sb, "links", 2 );
 3331  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 3332  0
                 append( sb, "Expression: ${links}", 3 );
 3333  0
                 append( sb, "", 0 );
 3334  
 
 3335  0
                 append( sb, "linksource (Default: false)", 2 );
 3336  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 3337  0
                 append( sb, "Expression: ${linksource}", 3 );
 3338  0
                 append( sb, "", 0 );
 3339  
 
 3340  0
                 append( sb, "locale", 2 );
 3341  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 3342  0
                 append( sb, "Expression: ${locale}", 3 );
 3343  0
                 append( sb, "", 0 );
 3344  
 
 3345  0
                 append( sb, "localRepository", 2 );
 3346  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 3347  0
                 append( sb, "Expression: ${localRepository}", 3 );
 3348  0
                 append( sb, "", 0 );
 3349  
 
 3350  0
                 append( sb, "maxmemory", 2 );
 3351  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 3352  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 3353  0
                 append( sb, "", 0 );
 3354  
 
 3355  0
                 append( sb, "minmemory", 2 );
 3356  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 3357  0
                 append( sb, "Expression: ${minmemory}", 3 );
 3358  0
                 append( sb, "", 0 );
 3359  
 
 3360  0
                 append( sb, "nocomment (Default: false)", 2 );
 3361  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 3362  0
                 append( sb, "Expression: ${nocomment}", 3 );
 3363  0
                 append( sb, "", 0 );
 3364  
 
 3365  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 3366  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 3367  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 3368  0
                 append( sb, "", 0 );
 3369  
 
 3370  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 3371  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 3372  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 3373  0
                 append( sb, "", 0 );
 3374  
 
 3375  0
                 append( sb, "nohelp (Default: false)", 2 );
 3376  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 3377  0
                 append( sb, "Expression: ${nohelp}", 3 );
 3378  0
                 append( sb, "", 0 );
 3379  
 
 3380  0
                 append( sb, "noindex (Default: false)", 2 );
 3381  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 3382  0
                 append( sb, "Expression: ${noindex}", 3 );
 3383  0
                 append( sb, "", 0 );
 3384  
 
 3385  0
                 append( sb, "nonavbar (Default: false)", 2 );
 3386  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 3387  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 3388  0
                 append( sb, "", 0 );
 3389  
 
 3390  0
                 append( sb, "nooverview (Default: false)", 2 );
 3391  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 3392  0
                 append( sb, "Expression: ${nooverview}", 3 );
 3393  0
                 append( sb, "", 0 );
 3394  
 
 3395  0
                 append( sb, "noqualifier", 2 );
 3396  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 3397  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 3398  0
                 append( sb, "", 0 );
 3399  
 
 3400  0
                 append( sb, "nosince (Default: false)", 2 );
 3401  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 3402  0
                 append( sb, "Expression: ${nosince}", 3 );
 3403  0
                 append( sb, "", 0 );
 3404  
 
 3405  0
                 append( sb, "notimestamp (Default: false)", 2 );
 3406  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 3407  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 3408  0
                 append( sb, "", 0 );
 3409  
 
 3410  0
                 append( sb, "notree (Default: false)", 2 );
 3411  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 3412  0
                 append( sb, "Expression: ${notree}", 3 );
 3413  0
                 append( sb, "", 0 );
 3414  
 
 3415  0
                 append( sb, "offlineLinks", 2 );
 3416  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 3417  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 3418  0
                 append( sb, "", 0 );
 3419  
 
 3420  0
                 append( sb, "old (Default: false)", 2 );
 3421  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 3422  0
                 append( sb, "Expression: ${old}", 3 );
 3423  0
                 append( sb, "", 0 );
 3424  
 
 3425  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
 3426  0
                 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
 3427  0
                 append( sb, "Required: Yes", 3 );
 3428  0
                 append( sb, "", 0 );
 3429  
 
 3430  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 3431  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 3432  0
                 append( sb, "Expression: ${overview}", 3 );
 3433  0
                 append( sb, "", 0 );
 3434  
 
 3435  0
                 append( sb, "packagesheader", 2 );
 3436  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 3437  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 3438  0
                 append( sb, "", 0 );
 3439  
 
 3440  0
                 append( sb, "proxyHost", 2 );
 3441  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 3442  0
                 append( sb, "", 0 );
 3443  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 3444  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 3445  0
                 append( sb, "", 0 );
 3446  
 
 3447  0
                 append( sb, "proxyPort", 2 );
 3448  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 3449  0
                 append( sb, "", 0 );
 3450  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 3451  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 3452  0
                 append( sb, "", 0 );
 3453  
 
 3454  0
                 append( sb, "quiet (Default: false)", 2 );
 3455  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 3456  0
                 append( sb, "Expression: ${quiet}", 3 );
 3457  0
                 append( sb, "", 0 );
 3458  
 
 3459  0
                 append( sb, "remoteRepositories", 2 );
 3460  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 3461  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 3462  0
                 append( sb, "", 0 );
 3463  
 
 3464  0
                 append( sb, "resourcesArtifacts", 2 );
 3465  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 3466  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 3467  0
                 append( sb, "", 0 );
 3468  
 
 3469  0
                 append( sb, "serialwarn (Default: false)", 2 );
 3470  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 3471  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 3472  0
                 append( sb, "", 0 );
 3473  
 
 3474  0
                 append( sb, "show (Default: protected)", 2 );
 3475  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 3476  0
                 append( sb, "Expression: ${show}", 3 );
 3477  0
                 append( sb, "", 0 );
 3478  
 
 3479  0
                 append( sb, "skip (Default: false)", 2 );
 3480  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 3481  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 3482  0
                 append( sb, "", 0 );
 3483  
 
 3484  0
                 append( sb, "source", 2 );
 3485  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 3486  0
                 append( sb, "Expression: ${source}", 3 );
 3487  0
                 append( sb, "", 0 );
 3488  
 
 3489  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 3490  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 3491  0
                 append( sb, "", 0 );
 3492  
 
 3493  0
                 append( sb, "sourcepath", 2 );
 3494  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 3495  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 3496  0
                 append( sb, "", 0 );
 3497  
 
 3498  0
                 append( sb, "sourcetab", 2 );
 3499  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 3500  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 3501  0
                 append( sb, "", 0 );
 3502  
 
 3503  0
                 append( sb, "splitindex (Default: false)", 2 );
 3504  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 3505  0
                 append( sb, "Expression: ${splitindex}", 3 );
 3506  0
                 append( sb, "", 0 );
 3507  
 
 3508  0
                 append( sb, "stylesheet (Default: java)", 2 );
 3509  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 3510  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 3511  0
                 append( sb, "", 0 );
 3512  
 
 3513  0
                 append( sb, "stylesheetfile", 2 );
 3514  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 3515  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 3516  0
                 append( sb, "", 0 );
 3517  
 
 3518  0
                 append( sb, "subpackages", 2 );
 3519  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 3520  0
                 append( sb, "Expression: ${subpackages}", 3 );
 3521  0
                 append( sb, "", 0 );
 3522  
 
 3523  0
                 append( sb, "taglet", 2 );
 3524  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 3525  0
                 append( sb, "Expression: ${taglet}", 3 );
 3526  0
                 append( sb, "", 0 );
 3527  
 
 3528  0
                 append( sb, "tagletArtifact", 2 );
 3529  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 3530  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 3531  0
                 append( sb, "", 0 );
 3532  
 
 3533  0
                 append( sb, "tagletArtifacts", 2 );
 3534  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 3535  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 3536  0
                 append( sb, "", 0 );
 3537  
 
 3538  0
                 append( sb, "tagletpath", 2 );
 3539  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 3540  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 3541  0
                 append( sb, "", 0 );
 3542  
 
 3543  0
                 append( sb, "taglets", 2 );
 3544  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 3545  0
                 append( sb, "Expression: ${taglets}", 3 );
 3546  0
                 append( sb, "", 0 );
 3547  
 
 3548  0
                 append( sb, "tags", 2 );
 3549  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 3550  0
                 append( sb, "Expression: ${tags}", 3 );
 3551  0
                 append( sb, "", 0 );
 3552  
 
 3553  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3554  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3555  0
                 append( sb, "Expression: ${testDoctitle}", 3 );
 3556  0
                 append( sb, "", 0 );
 3557  
 
 3558  0
                 append( sb, "testJavadocDirectory", 2 );
 3559  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 3560  0
                 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
 3561  0
                 append( sb, "", 0 );
 3562  
 
 3563  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 3564  0
                 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nSee overview.\n", 3 );
 3565  0
                 append( sb, "Expression: ${testOverview}", 3 );
 3566  0
                 append( sb, "", 0 );
 3567  
 
 3568  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3569  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3570  0
                 append( sb, "Expression: ${testWindowtitle}", 3 );
 3571  0
                 append( sb, "", 0 );
 3572  
 
 3573  0
                 append( sb, "top", 2 );
 3574  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 3575  0
                 append( sb, "Expression: ${top}", 3 );
 3576  0
                 append( sb, "", 0 );
 3577  
 
 3578  0
                 append( sb, "use (Default: true)", 2 );
 3579  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 3580  0
                 append( sb, "Expression: ${use}", 3 );
 3581  0
                 append( sb, "", 0 );
 3582  
 
 3583  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 3584  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 3585  0
                 append( sb, "", 0 );
 3586  
 
 3587  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 3588  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 3589  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 3590  0
                 append( sb, "", 0 );
 3591  
 
 3592  0
                 append( sb, "validateLinks (Default: false)", 2 );
 3593  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 3594  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 3595  0
                 append( sb, "", 0 );
 3596  
 
 3597  0
                 append( sb, "verbose (Default: false)", 2 );
 3598  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 3599  0
                 append( sb, "Expression: ${verbose}", 3 );
 3600  0
                 append( sb, "", 0 );
 3601  
 
 3602  0
                 append( sb, "version (Default: true)", 2 );
 3603  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 3604  0
                 append( sb, "Expression: ${version}", 3 );
 3605  0
                 append( sb, "", 0 );
 3606  
 
 3607  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 3608  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3609  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 3610  0
                 append( sb, "", 0 );
 3611  
             }
 3612  
         }
 3613  
 
 3614  0
         if ( goal == null || goal.length() <= 0 || "test-fix".equals( goal ) )
 3615  
         {
 3616  0
             append( sb, "javadoc:test-fix", 0 );
 3617  0
             append( sb, "Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.", 1 );
 3618  0
             append( sb, "", 0 );
 3619  0
             if ( detail )
 3620  
             {
 3621  0
                 append( sb, "Available parameters:", 1 );
 3622  0
                 append( sb, "", 0 );
 3623  
 
 3624  0
                 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
 3625  0
                 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
 3626  0
                 append( sb, "Expression: ${comparisonVersion}", 3 );
 3627  0
                 append( sb, "", 0 );
 3628  
 
 3629  0
                 append( sb, "defaultAuthor", 2 );
 3630  0
                 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
 3631  0
                 append( sb, "Expression: ${defaultAuthor}", 3 );
 3632  0
                 append( sb, "", 0 );
 3633  
 
 3634  0
                 append( sb, "defaultSince (Default: ${project.version})", 2 );
 3635  0
                 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
 3636  0
                 append( sb, "Expression: ${defaultSince}", 3 );
 3637  0
                 append( sb, "", 0 );
 3638  
 
 3639  0
                 append( sb, "defaultVersion", 2 );
 3640  0
                 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
 3641  0
                 append( sb, "Expression: ${defaultVersion}", 3 );
 3642  0
                 append( sb, "", 0 );
 3643  
 
 3644  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3645  0
                 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
 3646  0
                 append( sb, "Expression: ${encoding}", 3 );
 3647  0
                 append( sb, "", 0 );
 3648  
 
 3649  0
                 append( sb, "excludes", 2 );
 3650  0
                 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
 3651  0
                 append( sb, "Expression: ${excludes}", 3 );
 3652  0
                 append( sb, "", 0 );
 3653  
 
 3654  0
                 append( sb, "fixClassComment (Default: true)", 2 );
 3655  0
                 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
 3656  0
                 append( sb, "Expression: ${fixClassComment}", 3 );
 3657  0
                 append( sb, "", 0 );
 3658  
 
 3659  0
                 append( sb, "fixFieldComment (Default: true)", 2 );
 3660  0
                 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
 3661  0
                 append( sb, "Expression: ${fixFieldComment}", 3 );
 3662  0
                 append( sb, "", 0 );
 3663  
 
 3664  0
                 append( sb, "fixMethodComment (Default: true)", 2 );
 3665  0
                 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
 3666  0
                 append( sb, "Expression: ${fixMethodComment}", 3 );
 3667  0
                 append( sb, "", 0 );
 3668  
 
 3669  0
                 append( sb, "fixTags (Default: all)", 2 );
 3670  0
                 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n", 3 );
 3671  0
                 append( sb, "Expression: ${fixTags}", 3 );
 3672  0
                 append( sb, "", 0 );
 3673  
 
 3674  0
                 append( sb, "force", 2 );
 3675  0
                 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
 3676  0
                 append( sb, "Expression: ${force}", 3 );
 3677  0
                 append( sb, "", 0 );
 3678  
 
 3679  0
                 append( sb, "ignoreClirr (Default: false)", 2 );
 3680  0
                 append( sb, "Flag to ignore or not Clirr.", 3 );
 3681  0
                 append( sb, "Expression: ${ignoreClirr}", 3 );
 3682  0
                 append( sb, "", 0 );
 3683  
 
 3684  0
                 append( sb, "includes (Default: **/*.java)", 2 );
 3685  0
                 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
 3686  0
                 append( sb, "Expression: ${includes}", 3 );
 3687  0
                 append( sb, "", 0 );
 3688  
 
 3689  0
                 append( sb, "level (Default: protected)", 2 );
 3690  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 3691  0
                 append( sb, "Expression: ${level}", 3 );
 3692  0
                 append( sb, "", 0 );
 3693  
 
 3694  0
                 append( sb, "localRepository", 2 );
 3695  0
                 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
 3696  0
                 append( sb, "Expression: ${localRepository}", 3 );
 3697  0
                 append( sb, "", 0 );
 3698  
 
 3699  0
                 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
 3700  0
                 append( sb, "Output directory where Java classes will be rewritten.", 3 );
 3701  0
                 append( sb, "Expression: ${outputDirectory}", 3 );
 3702  0
                 append( sb, "", 0 );
 3703  
             }
 3704  
         }
 3705  
 
 3706  0
         if ( goal == null || goal.length() <= 0 || "test-jar".equals( goal ) )
 3707  
         {
 3708  0
             append( sb, "javadoc:test-jar", 0 );
 3709  0
             append( sb, "Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
 3710  0
             append( sb, "", 0 );
 3711  0
             if ( detail )
 3712  
             {
 3713  0
                 append( sb, "Available parameters:", 1 );
 3714  0
                 append( sb, "", 0 );
 3715  
 
 3716  0
                 append( sb, "additionalJOption", 2 );
 3717  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 3718  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 3719  0
                 append( sb, "", 0 );
 3720  
 
 3721  0
                 append( sb, "additionalparam", 2 );
 3722  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 3723  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 3724  0
                 append( sb, "", 0 );
 3725  
 
 3726  0
                 append( sb, "aggregate (Default: false)", 2 );
 3727  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 3728  0
                 append( sb, "", 0 );
 3729  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 3730  0
                 append( sb, "Expression: ${aggregate}", 3 );
 3731  0
                 append( sb, "", 0 );
 3732  
 
 3733  0
                 append( sb, "archive", 2 );
 3734  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 3735  0
                 append( sb, "", 0 );
 3736  
 
 3737  0
                 append( sb, "attach (Default: true)", 2 );
 3738  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 3739  0
                 append( sb, "Expression: ${attach}", 3 );
 3740  0
                 append( sb, "", 0 );
 3741  
 
 3742  0
                 append( sb, "author (Default: true)", 2 );
 3743  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 3744  0
                 append( sb, "Expression: ${author}", 3 );
 3745  0
                 append( sb, "", 0 );
 3746  
 
 3747  0
                 append( sb, "bootclasspath", 2 );
 3748  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 3749  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 3750  0
                 append( sb, "", 0 );
 3751  
 
 3752  0
                 append( sb, "bootclasspathArtifacts", 2 );
 3753  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 3754  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 3755  0
                 append( sb, "", 0 );
 3756  
 
 3757  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 3758  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 3759  0
                 append( sb, "Expression: ${bottom}", 3 );
 3760  0
                 append( sb, "", 0 );
 3761  
 
 3762  0
                 append( sb, "breakiterator (Default: false)", 2 );
 3763  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 3764  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 3765  0
                 append( sb, "", 0 );
 3766  
 
 3767  0
                 append( sb, "charset", 2 );
 3768  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 3769  0
                 append( sb, "Expression: ${charset}", 3 );
 3770  0
                 append( sb, "", 0 );
 3771  
 
 3772  0
                 append( sb, "debug (Default: false)", 2 );
 3773  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 3774  0
                 append( sb, "Expression: ${debug}", 3 );
 3775  0
                 append( sb, "", 0 );
 3776  
 
 3777  0
                 append( sb, "dependencySourceExcludes", 2 );
 3778  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 3779  0
                 append( sb, "", 0 );
 3780  
 
 3781  0
                 append( sb, "dependencySourceIncludes", 2 );
 3782  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 3783  0
                 append( sb, "", 0 );
 3784  
 
 3785  0
                 append( sb, "destDir", 2 );
 3786  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 3787  0
                 append( sb, "Expression: ${destDir}", 3 );
 3788  0
                 append( sb, "", 0 );
 3789  
 
 3790  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 3791  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 3792  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 3793  0
                 append( sb, "", 0 );
 3794  
 
 3795  0
                 append( sb, "detectLinks (Default: false)", 2 );
 3796  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 3797  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 3798  0
                 append( sb, "", 0 );
 3799  
 
 3800  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 3801  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 3802  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 3803  0
                 append( sb, "", 0 );
 3804  
 
 3805  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 3806  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 3807  0
                 append( sb, "Expression: ${docencoding}", 3 );
 3808  0
                 append( sb, "", 0 );
 3809  
 
 3810  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 3811  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 3812  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 3813  0
                 append( sb, "", 0 );
 3814  
 
 3815  0
                 append( sb, "doclet", 2 );
 3816  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 3817  0
                 append( sb, "Expression: ${doclet}", 3 );
 3818  0
                 append( sb, "", 0 );
 3819  
 
 3820  0
                 append( sb, "docletArtifact", 2 );
 3821  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 3822  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 3823  0
                 append( sb, "", 0 );
 3824  
 
 3825  0
                 append( sb, "docletArtifacts", 2 );
 3826  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 3827  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 3828  0
                 append( sb, "", 0 );
 3829  
 
 3830  0
                 append( sb, "docletPath", 2 );
 3831  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 3832  0
                 append( sb, "Expression: ${docletPath}", 3 );
 3833  0
                 append( sb, "", 0 );
 3834  
 
 3835  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 3836  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3837  0
                 append( sb, "Expression: ${doctitle}", 3 );
 3838  0
                 append( sb, "", 0 );
 3839  
 
 3840  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3841  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 3842  0
                 append( sb, "Expression: ${encoding}", 3 );
 3843  0
                 append( sb, "", 0 );
 3844  
 
 3845  0
                 append( sb, "excludedocfilessubdir", 2 );
 3846  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 3847  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 3848  0
                 append( sb, "", 0 );
 3849  
 
 3850  0
                 append( sb, "excludePackageNames", 2 );
 3851  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 3852  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 3853  0
                 append( sb, "", 0 );
 3854  
 
 3855  0
                 append( sb, "extdirs", 2 );
 3856  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 3857  0
                 append( sb, "Expression: ${extdirs}", 3 );
 3858  0
                 append( sb, "", 0 );
 3859  
 
 3860  0
                 append( sb, "failOnError (Default: true)", 2 );
 3861  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 3862  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 3863  0
                 append( sb, "", 0 );
 3864  
 
 3865  0
                 append( sb, "finalName", 2 );
 3866  0
                 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
 3867  0
                 append( sb, "Expression: ${project.build.finalName}", 3 );
 3868  0
                 append( sb, "", 0 );
 3869  
 
 3870  0
                 append( sb, "footer", 2 );
 3871  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 3872  0
                 append( sb, "Expression: ${footer}", 3 );
 3873  0
                 append( sb, "", 0 );
 3874  
 
 3875  0
                 append( sb, "groups", 2 );
 3876  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 3877  0
                 append( sb, "Expression: ${groups}", 3 );
 3878  0
                 append( sb, "", 0 );
 3879  
 
 3880  0
                 append( sb, "header", 2 );
 3881  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 3882  0
                 append( sb, "Expression: ${header}", 3 );
 3883  0
                 append( sb, "", 0 );
 3884  
 
 3885  0
                 append( sb, "helpfile", 2 );
 3886  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 3887  0
                 append( sb, "Expression: ${helpfile}", 3 );
 3888  0
                 append( sb, "", 0 );
 3889  
 
 3890  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 3891  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 3892  0
                 append( sb, "", 0 );
 3893  
 
 3894  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 3895  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 3896  0
                 append( sb, "", 0 );
 3897  
 
 3898  0
                 append( sb, "jarOutputDirectory", 2 );
 3899  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 3900  0
                 append( sb, "Expression: ${project.build.directory}", 3 );
 3901  0
                 append( sb, "", 0 );
 3902  
 
 3903  0
                 append( sb, "javaApiLinks", 2 );
 3904  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 3905  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 3906  0
                 append( sb, "", 0 );
 3907  
 
 3908  0
                 append( sb, "javadocDirectory", 2 );
 3909  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 3910  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 3911  0
                 append( sb, "", 0 );
 3912  
 
 3913  0
                 append( sb, "javadocExecutable", 2 );
 3914  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 3915  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 3916  0
                 append( sb, "", 0 );
 3917  
 
 3918  0
                 append( sb, "javadocVersion", 2 );
 3919  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 3920  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 3921  0
                 append( sb, "", 0 );
 3922  
 
 3923  0
                 append( sb, "keywords (Default: false)", 2 );
 3924  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 3925  0
                 append( sb, "Expression: ${keywords}", 3 );
 3926  0
                 append( sb, "", 0 );
 3927  
 
 3928  0
                 append( sb, "links", 2 );
 3929  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 3930  0
                 append( sb, "Expression: ${links}", 3 );
 3931  0
                 append( sb, "", 0 );
 3932  
 
 3933  0
                 append( sb, "linksource (Default: false)", 2 );
 3934  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 3935  0
                 append( sb, "Expression: ${linksource}", 3 );
 3936  0
                 append( sb, "", 0 );
 3937  
 
 3938  0
                 append( sb, "locale", 2 );
 3939  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 3940  0
                 append( sb, "Expression: ${locale}", 3 );
 3941  0
                 append( sb, "", 0 );
 3942  
 
 3943  0
                 append( sb, "localRepository", 2 );
 3944  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 3945  0
                 append( sb, "Expression: ${localRepository}", 3 );
 3946  0
                 append( sb, "", 0 );
 3947  
 
 3948  0
                 append( sb, "maxmemory", 2 );
 3949  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 3950  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 3951  0
                 append( sb, "", 0 );
 3952  
 
 3953  0
                 append( sb, "minmemory", 2 );
 3954  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 3955  0
                 append( sb, "Expression: ${minmemory}", 3 );
 3956  0
                 append( sb, "", 0 );
 3957  
 
 3958  0
                 append( sb, "nocomment (Default: false)", 2 );
 3959  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 3960  0
                 append( sb, "Expression: ${nocomment}", 3 );
 3961  0
                 append( sb, "", 0 );
 3962  
 
 3963  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 3964  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 3965  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 3966  0
                 append( sb, "", 0 );
 3967  
 
 3968  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 3969  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 3970  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 3971  0
                 append( sb, "", 0 );
 3972  
 
 3973  0
                 append( sb, "nohelp (Default: false)", 2 );
 3974  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 3975  0
                 append( sb, "Expression: ${nohelp}", 3 );
 3976  0
                 append( sb, "", 0 );
 3977  
 
 3978  0
                 append( sb, "noindex (Default: false)", 2 );
 3979  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 3980  0
                 append( sb, "Expression: ${noindex}", 3 );
 3981  0
                 append( sb, "", 0 );
 3982  
 
 3983  0
                 append( sb, "nonavbar (Default: false)", 2 );
 3984  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 3985  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 3986  0
                 append( sb, "", 0 );
 3987  
 
 3988  0
                 append( sb, "nooverview (Default: false)", 2 );
 3989  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 3990  0
                 append( sb, "Expression: ${nooverview}", 3 );
 3991  0
                 append( sb, "", 0 );
 3992  
 
 3993  0
                 append( sb, "noqualifier", 2 );
 3994  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 3995  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 3996  0
                 append( sb, "", 0 );
 3997  
 
 3998  0
                 append( sb, "nosince (Default: false)", 2 );
 3999  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 4000  0
                 append( sb, "Expression: ${nosince}", 3 );
 4001  0
                 append( sb, "", 0 );
 4002  
 
 4003  0
                 append( sb, "notimestamp (Default: false)", 2 );
 4004  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 4005  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 4006  0
                 append( sb, "", 0 );
 4007  
 
 4008  0
                 append( sb, "notree (Default: false)", 2 );
 4009  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 4010  0
                 append( sb, "Expression: ${notree}", 3 );
 4011  0
                 append( sb, "", 0 );
 4012  
 
 4013  0
                 append( sb, "offlineLinks", 2 );
 4014  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 4015  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 4016  0
                 append( sb, "", 0 );
 4017  
 
 4018  0
                 append( sb, "old (Default: false)", 2 );
 4019  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 4020  0
                 append( sb, "Expression: ${old}", 3 );
 4021  0
                 append( sb, "", 0 );
 4022  
 
 4023  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
 4024  0
                 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
 4025  0
                 append( sb, "Required: Yes", 3 );
 4026  0
                 append( sb, "", 0 );
 4027  
 
 4028  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 4029  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 4030  0
                 append( sb, "Expression: ${overview}", 3 );
 4031  0
                 append( sb, "", 0 );
 4032  
 
 4033  0
                 append( sb, "packagesheader", 2 );
 4034  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 4035  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 4036  0
                 append( sb, "", 0 );
 4037  
 
 4038  0
                 append( sb, "proxyHost", 2 );
 4039  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 4040  0
                 append( sb, "", 0 );
 4041  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 4042  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 4043  0
                 append( sb, "", 0 );
 4044  
 
 4045  0
                 append( sb, "proxyPort", 2 );
 4046  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 4047  0
                 append( sb, "", 0 );
 4048  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 4049  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 4050  0
                 append( sb, "", 0 );
 4051  
 
 4052  0
                 append( sb, "quiet (Default: false)", 2 );
 4053  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 4054  0
                 append( sb, "Expression: ${quiet}", 3 );
 4055  0
                 append( sb, "", 0 );
 4056  
 
 4057  0
                 append( sb, "remoteRepositories", 2 );
 4058  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 4059  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 4060  0
                 append( sb, "", 0 );
 4061  
 
 4062  0
                 append( sb, "resourcesArtifacts", 2 );
 4063  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 4064  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 4065  0
                 append( sb, "", 0 );
 4066  
 
 4067  0
                 append( sb, "serialwarn (Default: false)", 2 );
 4068  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 4069  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 4070  0
                 append( sb, "", 0 );
 4071  
 
 4072  0
                 append( sb, "show (Default: protected)", 2 );
 4073  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 4074  0
                 append( sb, "Expression: ${show}", 3 );
 4075  0
                 append( sb, "", 0 );
 4076  
 
 4077  0
                 append( sb, "skip (Default: false)", 2 );
 4078  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 4079  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 4080  0
                 append( sb, "", 0 );
 4081  
 
 4082  0
                 append( sb, "source", 2 );
 4083  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 4084  0
                 append( sb, "Expression: ${source}", 3 );
 4085  0
                 append( sb, "", 0 );
 4086  
 
 4087  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 4088  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 4089  0
                 append( sb, "", 0 );
 4090  
 
 4091  0
                 append( sb, "sourcepath", 2 );
 4092  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 4093  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 4094  0
                 append( sb, "", 0 );
 4095  
 
 4096  0
                 append( sb, "sourcetab", 2 );
 4097  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 4098  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 4099  0
                 append( sb, "", 0 );
 4100  
 
 4101  0
                 append( sb, "splitindex (Default: false)", 2 );
 4102  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 4103  0
                 append( sb, "Expression: ${splitindex}", 3 );
 4104  0
                 append( sb, "", 0 );
 4105  
 
 4106  0
                 append( sb, "stylesheet (Default: java)", 2 );
 4107  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 4108  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 4109  0
                 append( sb, "", 0 );
 4110  
 
 4111  0
                 append( sb, "stylesheetfile", 2 );
 4112  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 4113  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 4114  0
                 append( sb, "", 0 );
 4115  
 
 4116  0
                 append( sb, "subpackages", 2 );
 4117  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 4118  0
                 append( sb, "Expression: ${subpackages}", 3 );
 4119  0
                 append( sb, "", 0 );
 4120  
 
 4121  0
                 append( sb, "taglet", 2 );
 4122  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 4123  0
                 append( sb, "Expression: ${taglet}", 3 );
 4124  0
                 append( sb, "", 0 );
 4125  
 
 4126  0
                 append( sb, "tagletArtifact", 2 );
 4127  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 4128  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 4129  0
                 append( sb, "", 0 );
 4130  
 
 4131  0
                 append( sb, "tagletArtifacts", 2 );
 4132  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 4133  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 4134  0
                 append( sb, "", 0 );
 4135  
 
 4136  0
                 append( sb, "tagletpath", 2 );
 4137  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 4138  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 4139  0
                 append( sb, "", 0 );
 4140  
 
 4141  0
                 append( sb, "taglets", 2 );
 4142  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 4143  0
                 append( sb, "Expression: ${taglets}", 3 );
 4144  0
                 append( sb, "", 0 );
 4145  
 
 4146  0
                 append( sb, "tags", 2 );
 4147  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 4148  0
                 append( sb, "Expression: ${tags}", 3 );
 4149  0
                 append( sb, "", 0 );
 4150  
 
 4151  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 4152  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 4153  0
                 append( sb, "Expression: ${testDoctitle}", 3 );
 4154  0
                 append( sb, "", 0 );
 4155  
 
 4156  0
                 append( sb, "testJavadocDirectory", 2 );
 4157  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 4158  0
                 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
 4159  0
                 append( sb, "", 0 );
 4160  
 
 4161  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 4162  0
                 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nSee overview.\n", 3 );
 4163  0
                 append( sb, "Expression: ${testOverview}", 3 );
 4164  0
                 append( sb, "", 0 );
 4165  
 
 4166  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 4167  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 4168  0
                 append( sb, "Expression: ${testWindowtitle}", 3 );
 4169  0
                 append( sb, "", 0 );
 4170  
 
 4171  0
                 append( sb, "top", 2 );
 4172  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 4173  0
                 append( sb, "Expression: ${top}", 3 );
 4174  0
                 append( sb, "", 0 );
 4175  
 
 4176  0
                 append( sb, "use (Default: true)", 2 );
 4177  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 4178  0
                 append( sb, "Expression: ${use}", 3 );
 4179  0
                 append( sb, "", 0 );
 4180  
 
 4181  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 4182  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 4183  0
                 append( sb, "", 0 );
 4184  
 
 4185  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 4186  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 4187  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 4188  0
                 append( sb, "", 0 );
 4189  
 
 4190  0
                 append( sb, "validateLinks (Default: false)", 2 );
 4191  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 4192  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 4193  0
                 append( sb, "", 0 );
 4194  
 
 4195  0
                 append( sb, "verbose (Default: false)", 2 );
 4196  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 4197  0
                 append( sb, "Expression: ${verbose}", 3 );
 4198  0
                 append( sb, "", 0 );
 4199  
 
 4200  0
                 append( sb, "version (Default: true)", 2 );
 4201  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 4202  0
                 append( sb, "Expression: ${version}", 3 );
 4203  0
                 append( sb, "", 0 );
 4204  
 
 4205  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 4206  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 4207  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 4208  0
                 append( sb, "", 0 );
 4209  
             }
 4210  
         }
 4211  
 
 4212  0
         if ( goal == null || goal.length() <= 0 || "test-javadoc".equals( goal ) )
 4213  
         {
 4214  0
             append( sb, "javadoc:test-javadoc", 0 );
 4215  0
             append( sb, "Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.", 1 );
 4216  0
             append( sb, "", 0 );
 4217  0
             if ( detail )
 4218  
             {
 4219  0
                 append( sb, "Available parameters:", 1 );
 4220  0
                 append( sb, "", 0 );
 4221  
 
 4222  0
                 append( sb, "additionalJOption", 2 );
 4223  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 4224  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 4225  0
                 append( sb, "", 0 );
 4226  
 
 4227  0
                 append( sb, "additionalparam", 2 );
 4228  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 4229  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 4230  0
                 append( sb, "", 0 );
 4231  
 
 4232  0
                 append( sb, "aggregate (Default: false)", 2 );
 4233  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 4234  0
                 append( sb, "", 0 );
 4235  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 4236  0
                 append( sb, "Expression: ${aggregate}", 3 );
 4237  0
                 append( sb, "", 0 );
 4238  
 
 4239  0
                 append( sb, "author (Default: true)", 2 );
 4240  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 4241  0
                 append( sb, "Expression: ${author}", 3 );
 4242  0
                 append( sb, "", 0 );
 4243  
 
 4244  0
                 append( sb, "bootclasspath", 2 );
 4245  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 4246  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 4247  0
                 append( sb, "", 0 );
 4248  
 
 4249  0
                 append( sb, "bootclasspathArtifacts", 2 );
 4250  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 4251  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 4252  0
                 append( sb, "", 0 );
 4253  
 
 4254  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 4255  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 4256  0
                 append( sb, "Expression: ${bottom}", 3 );
 4257  0
                 append( sb, "", 0 );
 4258  
 
 4259  0
                 append( sb, "breakiterator (Default: false)", 2 );
 4260  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 4261  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 4262  0
                 append( sb, "", 0 );
 4263  
 
 4264  0
                 append( sb, "charset", 2 );
 4265  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 4266  0
                 append( sb, "Expression: ${charset}", 3 );
 4267  0
                 append( sb, "", 0 );
 4268  
 
 4269  0
                 append( sb, "debug (Default: false)", 2 );
 4270  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 4271  0
                 append( sb, "Expression: ${debug}", 3 );
 4272  0
                 append( sb, "", 0 );
 4273  
 
 4274  0
                 append( sb, "dependencySourceExcludes", 2 );
 4275  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 4276  0
                 append( sb, "", 0 );
 4277  
 
 4278  0
                 append( sb, "dependencySourceIncludes", 2 );
 4279  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 4280  0
                 append( sb, "", 0 );
 4281  
 
 4282  0
                 append( sb, "description", 2 );
 4283  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 4284  0
                 append( sb, "Expression: ${description}", 3 );
 4285  0
                 append( sb, "", 0 );
 4286  
 
 4287  0
                 append( sb, "destDir (Default: testapidocs)", 2 );
 4288  0
                 append( sb, "The name of the destination directory.\n", 3 );
 4289  0
                 append( sb, "Expression: ${destDir}", 3 );
 4290  0
                 append( sb, "", 0 );
 4291  
 
 4292  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 4293  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 4294  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 4295  0
                 append( sb, "", 0 );
 4296  
 
 4297  0
                 append( sb, "detectLinks (Default: false)", 2 );
 4298  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 4299  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 4300  0
                 append( sb, "", 0 );
 4301  
 
 4302  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 4303  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 4304  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 4305  0
                 append( sb, "", 0 );
 4306  
 
 4307  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 4308  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 4309  0
                 append( sb, "Expression: ${docencoding}", 3 );
 4310  0
                 append( sb, "", 0 );
 4311  
 
 4312  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 4313  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 4314  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 4315  0
                 append( sb, "", 0 );
 4316  
 
 4317  0
                 append( sb, "doclet", 2 );
 4318  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 4319  0
                 append( sb, "Expression: ${doclet}", 3 );
 4320  0
                 append( sb, "", 0 );
 4321  
 
 4322  0
                 append( sb, "docletArtifact", 2 );
 4323  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 4324  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 4325  0
                 append( sb, "", 0 );
 4326  
 
 4327  0
                 append( sb, "docletArtifacts", 2 );
 4328  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 4329  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 4330  0
                 append( sb, "", 0 );
 4331  
 
 4332  0
                 append( sb, "docletPath", 2 );
 4333  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 4334  0
                 append( sb, "Expression: ${docletPath}", 3 );
 4335  0
                 append( sb, "", 0 );
 4336  
 
 4337  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 4338  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 4339  0
                 append( sb, "Expression: ${doctitle}", 3 );
 4340  0
                 append( sb, "", 0 );
 4341  
 
 4342  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 4343  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 4344  0
                 append( sb, "Expression: ${encoding}", 3 );
 4345  0
                 append( sb, "", 0 );
 4346  
 
 4347  0
                 append( sb, "excludedocfilessubdir", 2 );
 4348  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 4349  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 4350  0
                 append( sb, "", 0 );
 4351  
 
 4352  0
                 append( sb, "excludePackageNames", 2 );
 4353  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 4354  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 4355  0
                 append( sb, "", 0 );
 4356  
 
 4357  0
                 append( sb, "extdirs", 2 );
 4358  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 4359  0
                 append( sb, "Expression: ${extdirs}", 3 );
 4360  0
                 append( sb, "", 0 );
 4361  
 
 4362  0
                 append( sb, "failOnError (Default: true)", 2 );
 4363  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 4364  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 4365  0
                 append( sb, "", 0 );
 4366  
 
 4367  0
                 append( sb, "footer", 2 );
 4368  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 4369  0
                 append( sb, "Expression: ${footer}", 3 );
 4370  0
                 append( sb, "", 0 );
 4371  
 
 4372  0
                 append( sb, "groups", 2 );
 4373  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 4374  0
                 append( sb, "Expression: ${groups}", 3 );
 4375  0
                 append( sb, "", 0 );
 4376  
 
 4377  0
                 append( sb, "header", 2 );
 4378  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 4379  0
                 append( sb, "Expression: ${header}", 3 );
 4380  0
                 append( sb, "", 0 );
 4381  
 
 4382  0
                 append( sb, "helpfile", 2 );
 4383  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 4384  0
                 append( sb, "Expression: ${helpfile}", 3 );
 4385  0
                 append( sb, "", 0 );
 4386  
 
 4387  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 4388  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 4389  0
                 append( sb, "", 0 );
 4390  
 
 4391  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 4392  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 4393  0
                 append( sb, "", 0 );
 4394  
 
 4395  0
                 append( sb, "javaApiLinks", 2 );
 4396  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 4397  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 4398  0
                 append( sb, "", 0 );
 4399  
 
 4400  0
                 append( sb, "javadocDirectory", 2 );
 4401  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 4402  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 4403  0
                 append( sb, "", 0 );
 4404  
 
 4405  0
                 append( sb, "javadocExecutable", 2 );
 4406  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 4407  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 4408  0
                 append( sb, "", 0 );
 4409  
 
 4410  0
                 append( sb, "javadocVersion", 2 );
 4411  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 4412  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 4413  0
                 append( sb, "", 0 );
 4414  
 
 4415  0
                 append( sb, "keywords (Default: false)", 2 );
 4416  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 4417  0
                 append( sb, "Expression: ${keywords}", 3 );
 4418  0
                 append( sb, "", 0 );
 4419  
 
 4420  0
                 append( sb, "links", 2 );
 4421  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 4422  0
                 append( sb, "Expression: ${links}", 3 );
 4423  0
                 append( sb, "", 0 );
 4424  
 
 4425  0
                 append( sb, "linksource (Default: false)", 2 );
 4426  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 4427  0
                 append( sb, "Expression: ${linksource}", 3 );
 4428  0
                 append( sb, "", 0 );
 4429  
 
 4430  0
                 append( sb, "locale", 2 );
 4431  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 4432  0
                 append( sb, "Expression: ${locale}", 3 );
 4433  0
                 append( sb, "", 0 );
 4434  
 
 4435  0
                 append( sb, "localRepository", 2 );
 4436  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 4437  0
                 append( sb, "Expression: ${localRepository}", 3 );
 4438  0
                 append( sb, "", 0 );
 4439  
 
 4440  0
                 append( sb, "maxmemory", 2 );
 4441  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 4442  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 4443  0
                 append( sb, "", 0 );
 4444  
 
 4445  0
                 append( sb, "minmemory", 2 );
 4446  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 4447  0
                 append( sb, "Expression: ${minmemory}", 3 );
 4448  0
                 append( sb, "", 0 );
 4449  
 
 4450  0
                 append( sb, "name", 2 );
 4451  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 4452  0
                 append( sb, "Expression: ${name}", 3 );
 4453  0
                 append( sb, "", 0 );
 4454  
 
 4455  0
                 append( sb, "nocomment (Default: false)", 2 );
 4456  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 4457  0
                 append( sb, "Expression: ${nocomment}", 3 );
 4458  0
                 append( sb, "", 0 );
 4459  
 
 4460  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 4461  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 4462  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 4463  0
                 append( sb, "", 0 );
 4464  
 
 4465  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 4466  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 4467  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 4468  0
                 append( sb, "", 0 );
 4469  
 
 4470  0
                 append( sb, "nohelp (Default: false)", 2 );
 4471  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 4472  0
                 append( sb, "Expression: ${nohelp}", 3 );
 4473  0
                 append( sb, "", 0 );
 4474  
 
 4475  0
                 append( sb, "noindex (Default: false)", 2 );
 4476  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 4477  0
                 append( sb, "Expression: ${noindex}", 3 );
 4478  0
                 append( sb, "", 0 );
 4479  
 
 4480  0
                 append( sb, "nonavbar (Default: false)", 2 );
 4481  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 4482  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 4483  0
                 append( sb, "", 0 );
 4484  
 
 4485  0
                 append( sb, "nooverview (Default: false)", 2 );
 4486  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 4487  0
                 append( sb, "Expression: ${nooverview}", 3 );
 4488  0
                 append( sb, "", 0 );
 4489  
 
 4490  0
                 append( sb, "noqualifier", 2 );
 4491  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 4492  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 4493  0
                 append( sb, "", 0 );
 4494  
 
 4495  0
                 append( sb, "nosince (Default: false)", 2 );
 4496  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 4497  0
                 append( sb, "Expression: ${nosince}", 3 );
 4498  0
                 append( sb, "", 0 );
 4499  
 
 4500  0
                 append( sb, "notimestamp (Default: false)", 2 );
 4501  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 4502  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 4503  0
                 append( sb, "", 0 );
 4504  
 
 4505  0
                 append( sb, "notree (Default: false)", 2 );
 4506  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 4507  0
                 append( sb, "Expression: ${notree}", 3 );
 4508  0
                 append( sb, "", 0 );
 4509  
 
 4510  0
                 append( sb, "offlineLinks", 2 );
 4511  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 4512  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 4513  0
                 append( sb, "", 0 );
 4514  
 
 4515  0
                 append( sb, "old (Default: false)", 2 );
 4516  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 4517  0
                 append( sb, "Expression: ${old}", 3 );
 4518  0
                 append( sb, "", 0 );
 4519  
 
 4520  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 4521  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 4522  0
                 append( sb, "Required: Yes", 3 );
 4523  0
                 append( sb, "Expression: ${destDir}", 3 );
 4524  0
                 append( sb, "", 0 );
 4525  
 
 4526  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 4527  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 4528  0
                 append( sb, "Expression: ${overview}", 3 );
 4529  0
                 append( sb, "", 0 );
 4530  
 
 4531  0
                 append( sb, "packagesheader", 2 );
 4532  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 4533  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 4534  0
                 append( sb, "", 0 );
 4535  
 
 4536  0
                 append( sb, "proxyHost", 2 );
 4537  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 4538  0
                 append( sb, "", 0 );
 4539  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 4540  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 4541  0
                 append( sb, "", 0 );
 4542  
 
 4543  0
                 append( sb, "proxyPort", 2 );
 4544  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 4545  0
                 append( sb, "", 0 );
 4546  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 4547  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 4548  0
                 append( sb, "", 0 );
 4549  
 
 4550  0
                 append( sb, "quiet (Default: false)", 2 );
 4551  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 4552  0
                 append( sb, "Expression: ${quiet}", 3 );
 4553  0
                 append( sb, "", 0 );
 4554  
 
 4555  0
                 append( sb, "remoteRepositories", 2 );
 4556  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 4557  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 4558  0
                 append( sb, "", 0 );
 4559  
 
 4560  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
 4561  0
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 4562  0
                 append( sb, "Required: Yes", 3 );
 4563  0
                 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
 4564  0
                 append( sb, "", 0 );
 4565  
 
 4566  0
                 append( sb, "resourcesArtifacts", 2 );
 4567  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 4568  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 4569  0
                 append( sb, "", 0 );
 4570  
 
 4571  0
                 append( sb, "serialwarn (Default: false)", 2 );
 4572  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 4573  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 4574  0
                 append( sb, "", 0 );
 4575  
 
 4576  0
                 append( sb, "show (Default: protected)", 2 );
 4577  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 4578  0
                 append( sb, "Expression: ${show}", 3 );
 4579  0
                 append( sb, "", 0 );
 4580  
 
 4581  0
                 append( sb, "skip (Default: false)", 2 );
 4582  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 4583  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 4584  0
                 append( sb, "", 0 );
 4585  
 
 4586  0
                 append( sb, "source", 2 );
 4587  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 4588  0
                 append( sb, "Expression: ${source}", 3 );
 4589  0
                 append( sb, "", 0 );
 4590  
 
 4591  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 4592  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 4593  0
                 append( sb, "", 0 );
 4594  
 
 4595  0
                 append( sb, "sourcepath", 2 );
 4596  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 4597  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 4598  0
                 append( sb, "", 0 );
 4599  
 
 4600  0
                 append( sb, "sourcetab", 2 );
 4601  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 4602  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 4603  0
                 append( sb, "", 0 );
 4604  
 
 4605  0
                 append( sb, "splitindex (Default: false)", 2 );
 4606  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 4607  0
                 append( sb, "Expression: ${splitindex}", 3 );
 4608  0
                 append( sb, "", 0 );
 4609  
 
 4610  0
                 append( sb, "stylesheet (Default: java)", 2 );
 4611  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 4612  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 4613  0
                 append( sb, "", 0 );
 4614  
 
 4615  0
                 append( sb, "stylesheetfile", 2 );
 4616  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 4617  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 4618  0
                 append( sb, "", 0 );
 4619  
 
 4620  0
                 append( sb, "subpackages", 2 );
 4621  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 4622  0
                 append( sb, "Expression: ${subpackages}", 3 );
 4623  0
                 append( sb, "", 0 );
 4624  
 
 4625  0
                 append( sb, "taglet", 2 );
 4626  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 4627  0
                 append( sb, "Expression: ${taglet}", 3 );
 4628  0
                 append( sb, "", 0 );
 4629  
 
 4630  0
                 append( sb, "tagletArtifact", 2 );
 4631  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 4632  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 4633  0
                 append( sb, "", 0 );
 4634  
 
 4635  0
                 append( sb, "tagletArtifacts", 2 );
 4636  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 4637  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 4638  0
                 append( sb, "", 0 );
 4639  
 
 4640  0
                 append( sb, "tagletpath", 2 );
 4641  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 4642  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 4643  0
                 append( sb, "", 0 );
 4644  
 
 4645  0
                 append( sb, "taglets", 2 );
 4646  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 4647  0
                 append( sb, "Expression: ${taglets}", 3 );
 4648  0
                 append( sb, "", 0 );
 4649  
 
 4650  0
                 append( sb, "tags", 2 );
 4651  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 4652  0
                 append( sb, "Expression: ${tags}", 3 );
 4653  0
                 append( sb, "", 0 );
 4654  
 
 4655  0
                 append( sb, "testDescription", 2 );
 4656  0
                 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 4657  0
                 append( sb, "Expression: ${testDescription}", 3 );
 4658  0
                 append( sb, "", 0 );
 4659  
 
 4660  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 4661  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 4662  0
                 append( sb, "Expression: ${testDoctitle}", 3 );
 4663  0
                 append( sb, "", 0 );
 4664  
 
 4665  0
                 append( sb, "testJavadocDirectory", 2 );
 4666  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 4667  0
                 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
 4668  0
                 append( sb, "", 0 );
 4669  
 
 4670  0
                 append( sb, "testName", 2 );
 4671  0
                 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 4672  0
                 append( sb, "Expression: ${testName}", 3 );
 4673  0
                 append( sb, "", 0 );
 4674  
 
 4675  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 4676  0
                 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 4677  0
                 append( sb, "Expression: ${testOverview}", 3 );
 4678  0
                 append( sb, "", 0 );
 4679  
 
 4680  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 4681  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 4682  0
                 append( sb, "Expression: ${testWindowtitle}", 3 );
 4683  0
                 append( sb, "", 0 );
 4684  
 
 4685  0
                 append( sb, "top", 2 );
 4686  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 4687  0
                 append( sb, "Expression: ${top}", 3 );
 4688  0
                 append( sb, "", 0 );
 4689  
 
 4690  0
                 append( sb, "use (Default: true)", 2 );
 4691  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 4692  0
                 append( sb, "Expression: ${use}", 3 );
 4693  0
                 append( sb, "", 0 );
 4694  
 
 4695  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 4696  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 4697  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 4698  0
                 append( sb, "", 0 );
 4699  
 
 4700  0
                 append( sb, "validateLinks (Default: false)", 2 );
 4701  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 4702  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 4703  0
                 append( sb, "", 0 );
 4704  
 
 4705  0
                 append( sb, "verbose (Default: false)", 2 );
 4706  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 4707  0
                 append( sb, "Expression: ${verbose}", 3 );
 4708  0
                 append( sb, "", 0 );
 4709  
 
 4710  0
                 append( sb, "version (Default: true)", 2 );
 4711  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 4712  0
                 append( sb, "Expression: ${version}", 3 );
 4713  0
                 append( sb, "", 0 );
 4714  
 
 4715  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 4716  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 4717  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 4718  0
                 append( sb, "", 0 );
 4719  
             }
 4720  
         }
 4721  
 
 4722  0
         if ( goal == null || goal.length() <= 0 || "test-resource-bundle".equals( goal ) )
 4723  
         {
 4724  0
             append( sb, "javadoc:test-resource-bundle", 0 );
 4725  0
             append( sb, "Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from AbstractJavadocMojo such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
 4726  0
             append( sb, "", 0 );
 4727  0
             if ( detail )
 4728  
             {
 4729  0
                 append( sb, "Available parameters:", 1 );
 4730  0
                 append( sb, "", 0 );
 4731  
 
 4732  0
                 append( sb, "additionalJOption", 2 );
 4733  0
                 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
 4734  0
                 append( sb, "Expression: ${additionalJOption}", 3 );
 4735  0
                 append( sb, "", 0 );
 4736  
 
 4737  0
                 append( sb, "additionalparam", 2 );
 4738  0
                 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
 4739  0
                 append( sb, "Expression: ${additionalparam}", 3 );
 4740  0
                 append( sb, "", 0 );
 4741  
 
 4742  0
                 append( sb, "aggregate (Default: false)", 2 );
 4743  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 4744  0
                 append( sb, "", 0 );
 4745  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 4746  0
                 append( sb, "Expression: ${aggregate}", 3 );
 4747  0
                 append( sb, "", 0 );
 4748  
 
 4749  0
                 append( sb, "author (Default: true)", 2 );
 4750  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 4751  0
                 append( sb, "Expression: ${author}", 3 );
 4752  0
                 append( sb, "", 0 );
 4753  
 
 4754  0
                 append( sb, "bootclasspath", 2 );
 4755  0
                 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
 4756  0
                 append( sb, "Expression: ${bootclasspath}", 3 );
 4757  0
                 append( sb, "", 0 );
 4758  
 
 4759  0
                 append( sb, "bootclasspathArtifacts", 2 );
 4760  0
                 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
 4761  0
                 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
 4762  0
                 append( sb, "", 0 );
 4763  
 
 4764  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 4765  0
                 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
 4766  0
                 append( sb, "Expression: ${bottom}", 3 );
 4767  0
                 append( sb, "", 0 );
 4768  
 
 4769  0
                 append( sb, "breakiterator (Default: false)", 2 );
 4770  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 4771  0
                 append( sb, "Expression: ${breakiterator}", 3 );
 4772  0
                 append( sb, "", 0 );
 4773  
 
 4774  0
                 append( sb, "charset", 2 );
 4775  0
                 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
 4776  0
                 append( sb, "Expression: ${charset}", 3 );
 4777  0
                 append( sb, "", 0 );
 4778  
 
 4779  0
                 append( sb, "debug (Default: false)", 2 );
 4780  0
                 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
 4781  0
                 append( sb, "Expression: ${debug}", 3 );
 4782  0
                 append( sb, "", 0 );
 4783  
 
 4784  0
                 append( sb, "dependencySourceExcludes", 2 );
 4785  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 4786  0
                 append( sb, "", 0 );
 4787  
 
 4788  0
                 append( sb, "dependencySourceIncludes", 2 );
 4789  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 4790  0
                 append( sb, "", 0 );
 4791  
 
 4792  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 4793  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
 4794  0
                 append( sb, "Expression: ${detectJavaApiLink}", 3 );
 4795  0
                 append( sb, "", 0 );
 4796  
 
 4797  0
                 append( sb, "detectLinks (Default: false)", 2 );
 4798  0
                 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
 4799  0
                 append( sb, "Expression: ${detectLinks}", 3 );
 4800  0
                 append( sb, "", 0 );
 4801  
 
 4802  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 4803  0
                 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
 4804  0
                 append( sb, "Expression: ${detectOfflineLinks}", 3 );
 4805  0
                 append( sb, "", 0 );
 4806  
 
 4807  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 4808  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 4809  0
                 append( sb, "Expression: ${docencoding}", 3 );
 4810  0
                 append( sb, "", 0 );
 4811  
 
 4812  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 4813  0
                 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 4814  0
                 append( sb, "Expression: ${docfilessubdirs}", 3 );
 4815  0
                 append( sb, "", 0 );
 4816  
 
 4817  0
                 append( sb, "doclet", 2 );
 4818  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 4819  0
                 append( sb, "Expression: ${doclet}", 3 );
 4820  0
                 append( sb, "", 0 );
 4821  
 
 4822  0
                 append( sb, "docletArtifact", 2 );
 4823  0
                 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
 4824  0
                 append( sb, "Expression: ${docletArtifact}", 3 );
 4825  0
                 append( sb, "", 0 );
 4826  
 
 4827  0
                 append( sb, "docletArtifacts", 2 );
 4828  0
                 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
 4829  0
                 append( sb, "Expression: ${docletArtifacts}", 3 );
 4830  0
                 append( sb, "", 0 );
 4831  
 
 4832  0
                 append( sb, "docletPath", 2 );
 4833  0
                 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
 4834  0
                 append( sb, "Expression: ${docletPath}", 3 );
 4835  0
                 append( sb, "", 0 );
 4836  
 
 4837  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 4838  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 4839  0
                 append( sb, "Expression: ${doctitle}", 3 );
 4840  0
                 append( sb, "", 0 );
 4841  
 
 4842  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 4843  0
                 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
 4844  0
                 append( sb, "Expression: ${encoding}", 3 );
 4845  0
                 append( sb, "", 0 );
 4846  
 
 4847  0
                 append( sb, "excludedocfilessubdir", 2 );
 4848  0
                 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
 4849  0
                 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
 4850  0
                 append( sb, "", 0 );
 4851  
 
 4852  0
                 append( sb, "excludePackageNames", 2 );
 4853  0
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
 4854  0
                 append( sb, "Expression: ${excludePackageNames}", 3 );
 4855  0
                 append( sb, "", 0 );
 4856  
 
 4857  0
                 append( sb, "extdirs", 2 );
 4858  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 4859  0
                 append( sb, "Expression: ${extdirs}", 3 );
 4860  0
                 append( sb, "", 0 );
 4861  
 
 4862  0
                 append( sb, "failOnError (Default: true)", 2 );
 4863  0
                 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
 4864  0
                 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
 4865  0
                 append( sb, "", 0 );
 4866  
 
 4867  0
                 append( sb, "footer", 2 );
 4868  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 4869  0
                 append( sb, "Expression: ${footer}", 3 );
 4870  0
                 append( sb, "", 0 );
 4871  
 
 4872  0
                 append( sb, "groups", 2 );
 4873  0
                 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
 4874  0
                 append( sb, "Expression: ${groups}", 3 );
 4875  0
                 append( sb, "", 0 );
 4876  
 
 4877  0
                 append( sb, "header", 2 );
 4878  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 4879  0
                 append( sb, "Expression: ${header}", 3 );
 4880  0
                 append( sb, "", 0 );
 4881  
 
 4882  0
                 append( sb, "helpfile", 2 );
 4883  0
                 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
 4884  0
                 append( sb, "Expression: ${helpfile}", 3 );
 4885  0
                 append( sb, "", 0 );
 4886  
 
 4887  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 4888  0
                 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
 4889  0
                 append( sb, "", 0 );
 4890  
 
 4891  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 4892  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 4893  0
                 append( sb, "", 0 );
 4894  
 
 4895  0
                 append( sb, "javaApiLinks", 2 );
 4896  0
                 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
 4897  0
                 append( sb, "Expression: ${javaApiLinks}", 3 );
 4898  0
                 append( sb, "", 0 );
 4899  
 
 4900  0
                 append( sb, "javadocDirectory", 2 );
 4901  0
                 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
 4902  0
                 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
 4903  0
                 append( sb, "", 0 );
 4904  
 
 4905  0
                 append( sb, "javadocExecutable", 2 );
 4906  0
                 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
 4907  0
                 append( sb, "Expression: ${javadocExecutable}", 3 );
 4908  0
                 append( sb, "", 0 );
 4909  
 
 4910  0
                 append( sb, "javadocVersion", 2 );
 4911  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 4912  0
                 append( sb, "Expression: ${javadocVersion}", 3 );
 4913  0
                 append( sb, "", 0 );
 4914  
 
 4915  0
                 append( sb, "keywords (Default: false)", 2 );
 4916  0
                 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
 4917  0
                 append( sb, "Expression: ${keywords}", 3 );
 4918  0
                 append( sb, "", 0 );
 4919  
 
 4920  0
                 append( sb, "links", 2 );
 4921  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
 4922  0
                 append( sb, "Expression: ${links}", 3 );
 4923  0
                 append( sb, "", 0 );
 4924  
 
 4925  0
                 append( sb, "linksource (Default: false)", 2 );
 4926  0
                 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
 4927  0
                 append( sb, "Expression: ${linksource}", 3 );
 4928  0
                 append( sb, "", 0 );
 4929  
 
 4930  0
                 append( sb, "locale", 2 );
 4931  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 4932  0
                 append( sb, "Expression: ${locale}", 3 );
 4933  0
                 append( sb, "", 0 );
 4934  
 
 4935  0
                 append( sb, "localRepository", 2 );
 4936  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 4937  0
                 append( sb, "Expression: ${localRepository}", 3 );
 4938  0
                 append( sb, "", 0 );
 4939  
 
 4940  0
                 append( sb, "maxmemory", 2 );
 4941  0
                 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 4942  0
                 append( sb, "Expression: ${maxmemory}", 3 );
 4943  0
                 append( sb, "", 0 );
 4944  
 
 4945  0
                 append( sb, "minmemory", 2 );
 4946  0
                 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
 4947  0
                 append( sb, "Expression: ${minmemory}", 3 );
 4948  0
                 append( sb, "", 0 );
 4949  
 
 4950  0
                 append( sb, "nocomment (Default: false)", 2 );
 4951  0
                 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
 4952  0
                 append( sb, "Expression: ${nocomment}", 3 );
 4953  0
                 append( sb, "", 0 );
 4954  
 
 4955  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 4956  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 4957  0
                 append( sb, "Expression: ${nodeprecated}", 3 );
 4958  0
                 append( sb, "", 0 );
 4959  
 
 4960  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 4961  0
                 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
 4962  0
                 append( sb, "Expression: ${nodeprecatedlist}", 3 );
 4963  0
                 append( sb, "", 0 );
 4964  
 
 4965  0
                 append( sb, "nohelp (Default: false)", 2 );
 4966  0
                 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
 4967  0
                 append( sb, "Expression: ${nohelp}", 3 );
 4968  0
                 append( sb, "", 0 );
 4969  
 
 4970  0
                 append( sb, "noindex (Default: false)", 2 );
 4971  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 4972  0
                 append( sb, "Expression: ${noindex}", 3 );
 4973  0
                 append( sb, "", 0 );
 4974  
 
 4975  0
                 append( sb, "nonavbar (Default: false)", 2 );
 4976  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 4977  0
                 append( sb, "Expression: ${nonavbar}", 3 );
 4978  0
                 append( sb, "", 0 );
 4979  
 
 4980  0
                 append( sb, "nooverview (Default: false)", 2 );
 4981  0
                 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
 4982  0
                 append( sb, "Expression: ${nooverview}", 3 );
 4983  0
                 append( sb, "", 0 );
 4984  
 
 4985  0
                 append( sb, "noqualifier", 2 );
 4986  0
                 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
 4987  0
                 append( sb, "Expression: ${noqualifier}", 3 );
 4988  0
                 append( sb, "", 0 );
 4989  
 
 4990  0
                 append( sb, "nosince (Default: false)", 2 );
 4991  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 4992  0
                 append( sb, "Expression: ${nosince}", 3 );
 4993  0
                 append( sb, "", 0 );
 4994  
 
 4995  0
                 append( sb, "notimestamp (Default: false)", 2 );
 4996  0
                 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
 4997  0
                 append( sb, "Expression: ${notimestamp}", 3 );
 4998  0
                 append( sb, "", 0 );
 4999  
 
 5000  0
                 append( sb, "notree (Default: false)", 2 );
 5001  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 5002  0
                 append( sb, "Expression: ${notree}", 3 );
 5003  0
                 append( sb, "", 0 );
 5004  
 
 5005  0
                 append( sb, "offlineLinks", 2 );
 5006  0
                 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
 5007  0
                 append( sb, "Expression: ${offlineLinks}", 3 );
 5008  0
                 append( sb, "", 0 );
 5009  
 
 5010  0
                 append( sb, "old (Default: false)", 2 );
 5011  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 5012  0
                 append( sb, "Expression: ${old}", 3 );
 5013  0
                 append( sb, "", 0 );
 5014  
 
 5015  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 5016  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 5017  0
                 append( sb, "Required: Yes", 3 );
 5018  0
                 append( sb, "Expression: ${destDir}", 3 );
 5019  0
                 append( sb, "", 0 );
 5020  
 
 5021  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 5022  0
                 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
 5023  0
                 append( sb, "Expression: ${overview}", 3 );
 5024  0
                 append( sb, "", 0 );
 5025  
 
 5026  0
                 append( sb, "packagesheader", 2 );
 5027  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 5028  0
                 append( sb, "Expression: ${packagesheader}", 3 );
 5029  0
                 append( sb, "", 0 );
 5030  
 
 5031  0
                 append( sb, "proxyHost", 2 );
 5032  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 5033  0
                 append( sb, "", 0 );
 5034  0
                 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 5035  0
                 append( sb, "Expression: ${proxyHost}", 3 );
 5036  0
                 append( sb, "", 0 );
 5037  
 
 5038  0
                 append( sb, "proxyPort", 2 );
 5039  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 5040  0
                 append( sb, "", 0 );
 5041  0
                 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
 5042  0
                 append( sb, "Expression: ${proxyPort}", 3 );
 5043  0
                 append( sb, "", 0 );
 5044  
 
 5045  0
                 append( sb, "quiet (Default: false)", 2 );
 5046  0
                 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
 5047  0
                 append( sb, "Expression: ${quiet}", 3 );
 5048  0
                 append( sb, "", 0 );
 5049  
 
 5050  0
                 append( sb, "remoteRepositories", 2 );
 5051  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 5052  0
                 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
 5053  0
                 append( sb, "", 0 );
 5054  
 
 5055  0
                 append( sb, "resourcesArtifacts", 2 );
 5056  0
                 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
 5057  0
                 append( sb, "Expression: ${resourcesArtifacts}", 3 );
 5058  0
                 append( sb, "", 0 );
 5059  
 
 5060  0
                 append( sb, "serialwarn (Default: false)", 2 );
 5061  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 5062  0
                 append( sb, "Expression: ${serialwarn}", 3 );
 5063  0
                 append( sb, "", 0 );
 5064  
 
 5065  0
                 append( sb, "show (Default: protected)", 2 );
 5066  0
                 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
 5067  0
                 append( sb, "Expression: ${show}", 3 );
 5068  0
                 append( sb, "", 0 );
 5069  
 
 5070  0
                 append( sb, "skip (Default: false)", 2 );
 5071  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 5072  0
                 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
 5073  0
                 append( sb, "", 0 );
 5074  
 
 5075  0
                 append( sb, "source", 2 );
 5076  0
                 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
 5077  0
                 append( sb, "Expression: ${source}", 3 );
 5078  0
                 append( sb, "", 0 );
 5079  
 
 5080  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 5081  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 5082  0
                 append( sb, "", 0 );
 5083  
 
 5084  0
                 append( sb, "sourcepath", 2 );
 5085  0
                 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
 5086  0
                 append( sb, "Expression: ${sourcepath}", 3 );
 5087  0
                 append( sb, "", 0 );
 5088  
 
 5089  0
                 append( sb, "sourcetab", 2 );
 5090  0
                 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
 5091  0
                 append( sb, "Expression: ${sourcetab}", 3 );
 5092  0
                 append( sb, "", 0 );
 5093  
 
 5094  0
                 append( sb, "splitindex (Default: false)", 2 );
 5095  0
                 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
 5096  0
                 append( sb, "Expression: ${splitindex}", 3 );
 5097  0
                 append( sb, "", 0 );
 5098  
 
 5099  0
                 append( sb, "stylesheet (Default: java)", 2 );
 5100  0
                 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
 5101  0
                 append( sb, "Expression: ${stylesheet}", 3 );
 5102  0
                 append( sb, "", 0 );
 5103  
 
 5104  0
                 append( sb, "stylesheetfile", 2 );
 5105  0
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
 5106  0
                 append( sb, "Expression: ${stylesheetfile}", 3 );
 5107  0
                 append( sb, "", 0 );
 5108  
 
 5109  0
                 append( sb, "subpackages", 2 );
 5110  0
                 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
 5111  0
                 append( sb, "Expression: ${subpackages}", 3 );
 5112  0
                 append( sb, "", 0 );
 5113  
 
 5114  0
                 append( sb, "taglet", 2 );
 5115  0
                 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
 5116  0
                 append( sb, "Expression: ${taglet}", 3 );
 5117  0
                 append( sb, "", 0 );
 5118  
 
 5119  0
                 append( sb, "tagletArtifact", 2 );
 5120  0
                 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
 5121  0
                 append( sb, "Expression: ${tagletArtifact}", 3 );
 5122  0
                 append( sb, "", 0 );
 5123  
 
 5124  0
                 append( sb, "tagletArtifacts", 2 );
 5125  0
                 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
 5126  0
                 append( sb, "Expression: ${tagletArtifacts}", 3 );
 5127  0
                 append( sb, "", 0 );
 5128  
 
 5129  0
                 append( sb, "tagletpath", 2 );
 5130  0
                 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
 5131  0
                 append( sb, "Expression: ${tagletpath}", 3 );
 5132  0
                 append( sb, "", 0 );
 5133  
 
 5134  0
                 append( sb, "taglets", 2 );
 5135  0
                 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
 5136  0
                 append( sb, "Expression: ${taglets}", 3 );
 5137  0
                 append( sb, "", 0 );
 5138  
 
 5139  0
                 append( sb, "tags", 2 );
 5140  0
                 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
 5141  0
                 append( sb, "Expression: ${tags}", 3 );
 5142  0
                 append( sb, "", 0 );
 5143  
 
 5144  0
                 append( sb, "testJavadocDirectory (Default: ${basedir}/src/test/javadoc)", 2 );
 5145  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 5146  0
                 append( sb, "", 0 );
 5147  
 
 5148  0
                 append( sb, "top", 2 );
 5149  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 5150  0
                 append( sb, "Expression: ${top}", 3 );
 5151  0
                 append( sb, "", 0 );
 5152  
 
 5153  0
                 append( sb, "use (Default: true)", 2 );
 5154  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 5155  0
                 append( sb, "Expression: ${use}", 3 );
 5156  0
                 append( sb, "", 0 );
 5157  
 
 5158  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 5159  0
                 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
 5160  0
                 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
 5161  0
                 append( sb, "", 0 );
 5162  
 
 5163  0
                 append( sb, "validateLinks (Default: false)", 2 );
 5164  0
                 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
 5165  0
                 append( sb, "Expression: ${validateLinks}", 3 );
 5166  0
                 append( sb, "", 0 );
 5167  
 
 5168  0
                 append( sb, "verbose (Default: false)", 2 );
 5169  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 5170  0
                 append( sb, "Expression: ${verbose}", 3 );
 5171  0
                 append( sb, "", 0 );
 5172  
 
 5173  0
                 append( sb, "version (Default: true)", 2 );
 5174  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 5175  0
                 append( sb, "Expression: ${version}", 3 );
 5176  0
                 append( sb, "", 0 );
 5177  
 
 5178  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 5179  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 5180  0
                 append( sb, "Expression: ${windowtitle}", 3 );
 5181  0
                 append( sb, "", 0 );
 5182  
             }
 5183  
         }
 5184  
 
 5185  0
         if ( getLog().isInfoEnabled() )
 5186  
         {
 5187  0
             getLog().info( sb.toString() );
 5188  
         }
 5189  0
     }
 5190  
 
 5191  
     /**
 5192  
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 5193  
      *
 5194  
      * @param str String to repeat
 5195  
      * @param repeat number of times to repeat str
 5196  
      * @return String with repeated String
 5197  
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 5198  
      * @throws NullPointerException if str is <code>null</code>
 5199  
      */
 5200  
     private static String repeat( String str, int repeat )
 5201  
     {
 5202  0
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 5203  
 
 5204  0
         for ( int i = 0; i < repeat; i++ )
 5205  
         {
 5206  0
             buffer.append( str );
 5207  
         }
 5208  
 
 5209  0
         return buffer.toString();
 5210  
     }
 5211  
 
 5212  
     /** 
 5213  
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 5214  
      * <b>Note</b>: The last character is always a new line.
 5215  
      * 
 5216  
      * @param sb The buffer to append the description, not <code>null</code>.
 5217  
      * @param description The description, not <code>null</code>.
 5218  
      * @param indent The base indentation level of each line, must not be negative.
 5219  
      */
 5220  
     private void append( StringBuffer sb, String description, int indent )
 5221  
     {
 5222  0
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 5223  
         {
 5224  0
             sb.append( it.next().toString() ).append( '\n' );
 5225  
         }
 5226  0
     }
 5227  
 
 5228  
     /** 
 5229  
      * Splits the specified text into lines of convenient display length.
 5230  
      * 
 5231  
      * @param text The text to split into lines, must not be <code>null</code>.
 5232  
      * @param indent The base indentation level of each line, must not be negative.
 5233  
      * @param indentSize The size of each indentation, must not be negative.
 5234  
      * @param lineLength The length of the line, must not be negative.
 5235  
      * @return The sequence of display lines, never <code>null</code>.
 5236  
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 5237  
      */
 5238  
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 5239  
     {
 5240  0
         List lines = new ArrayList();
 5241  
 
 5242  0
         String ind = repeat( "\t", indent );
 5243  0
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 5244  0
         for ( int i = 0; i < plainLines.length; i++ )
 5245  
         {
 5246  0
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 5247  
         }
 5248  
 
 5249  0
         return lines;
 5250  
     }
 5251  
 
 5252  
     /** 
 5253  
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 5254  
      * 
 5255  
      * @param lines The sequence of display lines, must not be <code>null</code>.
 5256  
      * @param line The line to add, must not be <code>null</code>.
 5257  
      * @param indentSize The size of each indentation, must not be negative.
 5258  
      * @param lineLength The length of the line, must not be negative.
 5259  
      */
 5260  
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 5261  
     {
 5262  0
         int lineIndent = getIndentLevel( line );
 5263  0
         StringBuffer buf = new StringBuffer( 256 );
 5264  0
         String[] tokens = line.split( " +" );
 5265  0
         for ( int i = 0; i < tokens.length; i++ )
 5266  
         {
 5267  0
             String token = tokens[i];
 5268  0
             if ( i > 0 )
 5269  
             {
 5270  0
                 if ( buf.length() + token.length() >= lineLength )
 5271  
                 {
 5272  0
                     lines.add( buf.toString() );
 5273  0
                     buf.setLength( 0 );
 5274  0
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 5275  
                 }
 5276  
                 else
 5277  
                 {
 5278  0
                     buf.append( ' ' );
 5279  
                 }
 5280  
             }
 5281  0
             for ( int j = 0; j < token.length(); j++ )
 5282  
             {
 5283  0
                 char c = token.charAt( j );
 5284  0
                 if ( c == '\t' )
 5285  
                 {
 5286  0
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 5287  
                 }
 5288  0
                 else if ( c == '\u00A0' )
 5289  
                 {
 5290  0
                     buf.append( ' ' );
 5291  
                 }
 5292  
                 else
 5293  
                 {
 5294  0
                     buf.append( c );
 5295  
                 }
 5296  
             }
 5297  
         }
 5298  0
         lines.add( buf.toString() );
 5299  0
     }
 5300  
 
 5301  
     /** 
 5302  
      * Gets the indentation level of the specified line.
 5303  
      * 
 5304  
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 5305  
      * @return The indentation level of the line.
 5306  
      */
 5307  
     private static int getIndentLevel( String line )
 5308  
     {
 5309  0
         int level = 0;
 5310  0
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 5311  
         {
 5312  0
             level++;
 5313  
         }
 5314  0
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 5315  
         {
 5316  0
             if ( line.charAt( i ) == '\t' )
 5317  
             {
 5318  0
                 level++;
 5319  0
                 break;
 5320  
             }
 5321  
         }
 5322  0
         return level;
 5323  
     }
 5324  
 }