Coverage Report - org.apache.maven.plugin.javadoc.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0%
0/3142
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 Fri Apr 30 14:55:57 EDT 2010
 14  
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.5.1)
 15  
  * @goal help
 16  
  * @requiresProject false
 17  
  */
 18  0
 public class HelpMojo
 19  
     extends AbstractMojo
 20  
 {
 21  
     /**
 22  
      * If <code>true</code>, display all settable properties for each goal.
 23  
      * 
 24  
      * @parameter expression="${detail}" default-value="false"
 25  
      */
 26  
     private boolean detail;
 27  
 
 28  
     /**
 29  
      * The name of the goal for which to show help. If unspecified, all goals will be displayed.
 30  
      * 
 31  
      * @parameter expression="${goal}"
 32  
      */
 33  
     private java.lang.String goal;
 34  
 
 35  
     /**
 36  
      * The maximum length of a display line, should be positive.
 37  
      * 
 38  
      * @parameter expression="${lineLength}" default-value="80"
 39  
      */
 40  
     private int lineLength;
 41  
 
 42  
     /**
 43  
      * The number of spaces per indentation level, should be positive.
 44  
      * 
 45  
      * @parameter expression="${indentSize}" default-value="2"
 46  
      */
 47  
     private int indentSize;
 48  
 
 49  
 
 50  
     /** {@inheritDoc} */
 51  
     public void execute()
 52  
         throws MojoExecutionException
 53  
     {
 54  0
         if ( lineLength <= 0 )
 55  
         {
 56  0
             getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
 57  0
             lineLength = 80;
 58  
         }
 59  0
         if ( indentSize <= 0 )
 60  
         {
 61  0
             getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
 62  0
             indentSize = 2;
 63  
         }
 64  
 
 65  0
         StringBuffer sb = new StringBuffer();
 66  
 
 67  0
         append( sb, "org.apache.maven.plugins:maven-javadoc-plugin:2.7", 0 );
 68  0
         append( sb, "", 0 );
 69  
 
 70  0
         append( sb, "Maven Javadoc Plugin", 0 );
 71  0
         append( sb, "The Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.", 1 );
 72  0
         append( sb, "", 0 );
 73  
 
 74  0
         if ( goal == null || goal.length() <= 0 )
 75  
         {
 76  0
             append( sb, "This plugin has 13 goals:", 0 );
 77  0
             append( sb, "", 0 );
 78  
         }
 79  
 
 80  0
         if ( goal == null || goal.length() <= 0 || "aggregate".equals( goal ) )
 81  
         {
 82  0
             append( sb, "javadoc:aggregate", 0 );
 83  0
             append( sb, "Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.", 1 );
 84  0
             append( sb, "", 0 );
 85  0
             if ( detail )
 86  
             {
 87  0
                 append( sb, "Available parameters:", 1 );
 88  0
                 append( sb, "", 0 );
 89  
 
 90  0
                 append( sb, "additionalJOption", 2 );
 91  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 );
 92  0
                 append( sb, "", 0 );
 93  
 
 94  0
                 append( sb, "additionalparam", 2 );
 95  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 );
 96  0
                 append( sb, "", 0 );
 97  
 
 98  0
                 append( sb, "aggregate (Default: false)", 2 );
 99  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 100  0
                 append( sb, "", 0 );
 101  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 102  0
                 append( sb, "", 0 );
 103  
 
 104  0
                 append( sb, "author (Default: true)", 2 );
 105  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 106  0
                 append( sb, "", 0 );
 107  
 
 108  0
                 append( sb, "bootclasspath", 2 );
 109  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 );
 110  0
                 append( sb, "", 0 );
 111  
 
 112  0
                 append( sb, "bootclasspathArtifacts", 2 );
 113  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 );
 114  0
                 append( sb, "", 0 );
 115  
 
 116  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 117  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 );
 118  0
                 append( sb, "", 0 );
 119  
 
 120  0
                 append( sb, "breakiterator (Default: false)", 2 );
 121  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 122  0
                 append( sb, "", 0 );
 123  
 
 124  0
                 append( sb, "charset", 2 );
 125  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 );
 126  0
                 append( sb, "", 0 );
 127  
 
 128  0
                 append( sb, "debug (Default: false)", 2 );
 129  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 );
 130  0
                 append( sb, "", 0 );
 131  
 
 132  0
                 append( sb, "dependencySourceExcludes", 2 );
 133  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 134  0
                 append( sb, "", 0 );
 135  
 
 136  0
                 append( sb, "dependencySourceIncludes", 2 );
 137  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 138  0
                 append( sb, "", 0 );
 139  
 
 140  0
                 append( sb, "description", 2 );
 141  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 142  0
                 append( sb, "", 0 );
 143  
 
 144  0
                 append( sb, "destDir (Default: apidocs)", 2 );
 145  0
                 append( sb, "The name of the destination directory.\n", 3 );
 146  0
                 append( sb, "", 0 );
 147  
 
 148  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 149  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 150  0
                 append( sb, "", 0 );
 151  
 
 152  0
                 append( sb, "detectLinks (Default: false)", 2 );
 153  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 );
 154  0
                 append( sb, "", 0 );
 155  
 
 156  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 157  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 );
 158  0
                 append( sb, "", 0 );
 159  
 
 160  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 161  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 162  0
                 append( sb, "", 0 );
 163  
 
 164  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 165  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 );
 166  0
                 append( sb, "", 0 );
 167  
 
 168  0
                 append( sb, "doclet", 2 );
 169  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 170  0
                 append( sb, "", 0 );
 171  
 
 172  0
                 append( sb, "docletArtifact", 2 );
 173  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 );
 174  0
                 append( sb, "", 0 );
 175  
 
 176  0
                 append( sb, "docletArtifacts", 2 );
 177  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 );
 178  0
                 append( sb, "", 0 );
 179  
 
 180  0
                 append( sb, "docletPath", 2 );
 181  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 );
 182  0
                 append( sb, "", 0 );
 183  
 
 184  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 185  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 186  0
                 append( sb, "", 0 );
 187  
 
 188  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 189  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 );
 190  0
                 append( sb, "", 0 );
 191  
 
 192  0
                 append( sb, "excludedocfilessubdir", 2 );
 193  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 );
 194  0
                 append( sb, "", 0 );
 195  
 
 196  0
                 append( sb, "excludePackageNames", 2 );
 197  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 );
 198  0
                 append( sb, "", 0 );
 199  
 
 200  0
                 append( sb, "extdirs", 2 );
 201  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 202  0
                 append( sb, "", 0 );
 203  
 
 204  0
                 append( sb, "failOnError (Default: true)", 2 );
 205  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 206  0
                 append( sb, "", 0 );
 207  
 
 208  0
                 append( sb, "footer", 2 );
 209  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 210  0
                 append( sb, "", 0 );
 211  
 
 212  0
                 append( sb, "groups", 2 );
 213  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 );
 214  0
                 append( sb, "", 0 );
 215  
 
 216  0
                 append( sb, "header", 2 );
 217  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 218  0
                 append( sb, "", 0 );
 219  
 
 220  0
                 append( sb, "helpfile", 2 );
 221  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 );
 222  0
                 append( sb, "", 0 );
 223  
 
 224  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 225  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 );
 226  0
                 append( sb, "", 0 );
 227  
 
 228  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 229  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 230  0
                 append( sb, "", 0 );
 231  
 
 232  0
                 append( sb, "javaApiLinks", 2 );
 233  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 );
 234  0
                 append( sb, "", 0 );
 235  
 
 236  0
                 append( sb, "javadocDirectory", 2 );
 237  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 );
 238  0
                 append( sb, "", 0 );
 239  
 
 240  0
                 append( sb, "javadocExecutable", 2 );
 241  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 );
 242  0
                 append( sb, "", 0 );
 243  
 
 244  0
                 append( sb, "javadocVersion", 2 );
 245  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 246  0
                 append( sb, "", 0 );
 247  
 
 248  0
                 append( sb, "keywords (Default: false)", 2 );
 249  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 );
 250  0
                 append( sb, "", 0 );
 251  
 
 252  0
                 append( sb, "links", 2 );
 253  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 254  0
                 append( sb, "", 0 );
 255  
 
 256  0
                 append( sb, "linksource (Default: false)", 2 );
 257  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 );
 258  0
                 append( sb, "", 0 );
 259  
 
 260  0
                 append( sb, "locale", 2 );
 261  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 262  0
                 append( sb, "", 0 );
 263  
 
 264  0
                 append( sb, "localRepository", 2 );
 265  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 266  0
                 append( sb, "", 0 );
 267  
 
 268  0
                 append( sb, "maxmemory", 2 );
 269  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 );
 270  0
                 append( sb, "", 0 );
 271  
 
 272  0
                 append( sb, "minmemory", 2 );
 273  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 );
 274  0
                 append( sb, "", 0 );
 275  
 
 276  0
                 append( sb, "name", 2 );
 277  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 278  0
                 append( sb, "", 0 );
 279  
 
 280  0
                 append( sb, "nocomment (Default: false)", 2 );
 281  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 );
 282  0
                 append( sb, "", 0 );
 283  
 
 284  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 285  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 286  0
                 append( sb, "", 0 );
 287  
 
 288  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 289  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 );
 290  0
                 append( sb, "", 0 );
 291  
 
 292  0
                 append( sb, "nohelp (Default: false)", 2 );
 293  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 );
 294  0
                 append( sb, "", 0 );
 295  
 
 296  0
                 append( sb, "noindex (Default: false)", 2 );
 297  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 298  0
                 append( sb, "", 0 );
 299  
 
 300  0
                 append( sb, "nonavbar (Default: false)", 2 );
 301  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 302  0
                 append( sb, "", 0 );
 303  
 
 304  0
                 append( sb, "nooverview (Default: false)", 2 );
 305  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 );
 306  0
                 append( sb, "", 0 );
 307  
 
 308  0
                 append( sb, "noqualifier", 2 );
 309  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 );
 310  0
                 append( sb, "", 0 );
 311  
 
 312  0
                 append( sb, "nosince (Default: false)", 2 );
 313  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 314  0
                 append( sb, "", 0 );
 315  
 
 316  0
                 append( sb, "notimestamp (Default: false)", 2 );
 317  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 );
 318  0
                 append( sb, "", 0 );
 319  
 
 320  0
                 append( sb, "notree (Default: false)", 2 );
 321  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 322  0
                 append( sb, "", 0 );
 323  
 
 324  0
                 append( sb, "offlineLinks", 2 );
 325  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://java.sun.com/j2se/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 );
 326  0
                 append( sb, "", 0 );
 327  
 
 328  0
                 append( sb, "old (Default: false)", 2 );
 329  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 330  0
                 append( sb, "", 0 );
 331  
 
 332  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 333  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 334  0
                 append( sb, "", 0 );
 335  
 
 336  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 337  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 );
 338  0
                 append( sb, "", 0 );
 339  
 
 340  0
                 append( sb, "packagesheader", 2 );
 341  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 342  0
                 append( sb, "", 0 );
 343  
 
 344  0
                 append( sb, "proxyHost", 2 );
 345  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 346  0
                 append( sb, "", 0 );
 347  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 );
 348  0
                 append( sb, "", 0 );
 349  
 
 350  0
                 append( sb, "proxyPort", 2 );
 351  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 352  0
                 append( sb, "", 0 );
 353  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 );
 354  0
                 append( sb, "", 0 );
 355  
 
 356  0
                 append( sb, "quiet (Default: false)", 2 );
 357  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 );
 358  0
                 append( sb, "", 0 );
 359  
 
 360  0
                 append( sb, "remoteRepositories", 2 );
 361  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 362  0
                 append( sb, "", 0 );
 363  
 
 364  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
 365  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 366  0
                 append( sb, "", 0 );
 367  
 
 368  0
                 append( sb, "resourcesArtifacts", 2 );
 369  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 );
 370  0
                 append( sb, "", 0 );
 371  
 
 372  0
                 append( sb, "serialwarn (Default: false)", 2 );
 373  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 374  0
                 append( sb, "", 0 );
 375  
 
 376  0
                 append( sb, "show (Default: protected)", 2 );
 377  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 );
 378  0
                 append( sb, "", 0 );
 379  
 
 380  0
                 append( sb, "skip (Default: false)", 2 );
 381  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 382  0
                 append( sb, "", 0 );
 383  
 
 384  0
                 append( sb, "source", 2 );
 385  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 );
 386  0
                 append( sb, "", 0 );
 387  
 
 388  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 389  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 390  0
                 append( sb, "", 0 );
 391  
 
 392  0
                 append( sb, "sourcepath", 2 );
 393  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 );
 394  0
                 append( sb, "", 0 );
 395  
 
 396  0
                 append( sb, "sourcetab", 2 );
 397  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 );
 398  0
                 append( sb, "", 0 );
 399  
 
 400  0
                 append( sb, "splitindex (Default: false)", 2 );
 401  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 );
 402  0
                 append( sb, "", 0 );
 403  
 
 404  0
                 append( sb, "stylesheet (Default: java)", 2 );
 405  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 );
 406  0
                 append( sb, "", 0 );
 407  
 
 408  0
                 append( sb, "stylesheetfile", 2 );
 409  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 );
 410  0
                 append( sb, "", 0 );
 411  
 
 412  0
                 append( sb, "subpackages", 2 );
 413  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 );
 414  0
                 append( sb, "", 0 );
 415  
 
 416  0
                 append( sb, "taglet", 2 );
 417  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 );
 418  0
                 append( sb, "", 0 );
 419  
 
 420  0
                 append( sb, "tagletArtifact", 2 );
 421  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 );
 422  0
                 append( sb, "", 0 );
 423  
 
 424  0
                 append( sb, "tagletArtifacts", 2 );
 425  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 );
 426  0
                 append( sb, "", 0 );
 427  
 
 428  0
                 append( sb, "tagletpath", 2 );
 429  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 );
 430  0
                 append( sb, "", 0 );
 431  
 
 432  0
                 append( sb, "taglets", 2 );
 433  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 );
 434  0
                 append( sb, "", 0 );
 435  
 
 436  0
                 append( sb, "tags", 2 );
 437  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 );
 438  0
                 append( sb, "", 0 );
 439  
 
 440  0
                 append( sb, "top", 2 );
 441  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 442  0
                 append( sb, "", 0 );
 443  
 
 444  0
                 append( sb, "use (Default: true)", 2 );
 445  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 446  0
                 append( sb, "", 0 );
 447  
 
 448  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 449  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 );
 450  0
                 append( sb, "", 0 );
 451  
 
 452  0
                 append( sb, "verbose (Default: false)", 2 );
 453  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 454  0
                 append( sb, "", 0 );
 455  
 
 456  0
                 append( sb, "version (Default: true)", 2 );
 457  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 458  0
                 append( sb, "", 0 );
 459  
 
 460  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 461  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 462  0
                 append( sb, "", 0 );
 463  
             }
 464  
         }
 465  
 
 466  0
         if ( goal == null || goal.length() <= 0 || "aggregate-jar".equals( goal ) )
 467  
         {
 468  0
             append( sb, "javadoc:aggregate-jar", 0 );
 469  0
             append( sb, "Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
 470  0
             append( sb, "", 0 );
 471  0
             if ( detail )
 472  
             {
 473  0
                 append( sb, "Available parameters:", 1 );
 474  0
                 append( sb, "", 0 );
 475  
 
 476  0
                 append( sb, "additionalJOption", 2 );
 477  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 );
 478  0
                 append( sb, "", 0 );
 479  
 
 480  0
                 append( sb, "additionalparam", 2 );
 481  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 );
 482  0
                 append( sb, "", 0 );
 483  
 
 484  0
                 append( sb, "aggregate (Default: false)", 2 );
 485  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 486  0
                 append( sb, "", 0 );
 487  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 488  0
                 append( sb, "", 0 );
 489  
 
 490  0
                 append( sb, "archive", 2 );
 491  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 492  0
                 append( sb, "", 0 );
 493  
 
 494  0
                 append( sb, "attach (Default: true)", 2 );
 495  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 496  0
                 append( sb, "", 0 );
 497  
 
 498  0
                 append( sb, "author (Default: true)", 2 );
 499  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 500  0
                 append( sb, "", 0 );
 501  
 
 502  0
                 append( sb, "bootclasspath", 2 );
 503  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 );
 504  0
                 append( sb, "", 0 );
 505  
 
 506  0
                 append( sb, "bootclasspathArtifacts", 2 );
 507  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 );
 508  0
                 append( sb, "", 0 );
 509  
 
 510  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 511  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 );
 512  0
                 append( sb, "", 0 );
 513  
 
 514  0
                 append( sb, "breakiterator (Default: false)", 2 );
 515  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 516  0
                 append( sb, "", 0 );
 517  
 
 518  0
                 append( sb, "charset", 2 );
 519  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 );
 520  0
                 append( sb, "", 0 );
 521  
 
 522  0
                 append( sb, "debug (Default: false)", 2 );
 523  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 );
 524  0
                 append( sb, "", 0 );
 525  
 
 526  0
                 append( sb, "dependencySourceExcludes", 2 );
 527  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 528  0
                 append( sb, "", 0 );
 529  
 
 530  0
                 append( sb, "dependencySourceIncludes", 2 );
 531  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 532  0
                 append( sb, "", 0 );
 533  
 
 534  0
                 append( sb, "destDir", 2 );
 535  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 536  0
                 append( sb, "", 0 );
 537  
 
 538  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 539  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 540  0
                 append( sb, "", 0 );
 541  
 
 542  0
                 append( sb, "detectLinks (Default: false)", 2 );
 543  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 );
 544  0
                 append( sb, "", 0 );
 545  
 
 546  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 547  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 );
 548  0
                 append( sb, "", 0 );
 549  
 
 550  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 551  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 552  0
                 append( sb, "", 0 );
 553  
 
 554  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 555  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 );
 556  0
                 append( sb, "", 0 );
 557  
 
 558  0
                 append( sb, "doclet", 2 );
 559  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 560  0
                 append( sb, "", 0 );
 561  
 
 562  0
                 append( sb, "docletArtifact", 2 );
 563  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 );
 564  0
                 append( sb, "", 0 );
 565  
 
 566  0
                 append( sb, "docletArtifacts", 2 );
 567  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 );
 568  0
                 append( sb, "", 0 );
 569  
 
 570  0
                 append( sb, "docletPath", 2 );
 571  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 );
 572  0
                 append( sb, "", 0 );
 573  
 
 574  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 575  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 576  0
                 append( sb, "", 0 );
 577  
 
 578  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 579  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 );
 580  0
                 append( sb, "", 0 );
 581  
 
 582  0
                 append( sb, "excludedocfilessubdir", 2 );
 583  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 );
 584  0
                 append( sb, "", 0 );
 585  
 
 586  0
                 append( sb, "excludePackageNames", 2 );
 587  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 );
 588  0
                 append( sb, "", 0 );
 589  
 
 590  0
                 append( sb, "extdirs", 2 );
 591  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 592  0
                 append( sb, "", 0 );
 593  
 
 594  0
                 append( sb, "failOnError (Default: true)", 2 );
 595  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 596  0
                 append( sb, "", 0 );
 597  
 
 598  0
                 append( sb, "finalName", 2 );
 599  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 );
 600  0
                 append( sb, "", 0 );
 601  
 
 602  0
                 append( sb, "footer", 2 );
 603  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 604  0
                 append( sb, "", 0 );
 605  
 
 606  0
                 append( sb, "groups", 2 );
 607  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 );
 608  0
                 append( sb, "", 0 );
 609  
 
 610  0
                 append( sb, "header", 2 );
 611  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 612  0
                 append( sb, "", 0 );
 613  
 
 614  0
                 append( sb, "helpfile", 2 );
 615  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 );
 616  0
                 append( sb, "", 0 );
 617  
 
 618  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 619  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 );
 620  0
                 append( sb, "", 0 );
 621  
 
 622  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 623  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 624  0
                 append( sb, "", 0 );
 625  
 
 626  0
                 append( sb, "jarOutputDirectory", 2 );
 627  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 628  0
                 append( sb, "", 0 );
 629  
 
 630  0
                 append( sb, "javaApiLinks", 2 );
 631  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 );
 632  0
                 append( sb, "", 0 );
 633  
 
 634  0
                 append( sb, "javadocDirectory", 2 );
 635  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 );
 636  0
                 append( sb, "", 0 );
 637  
 
 638  0
                 append( sb, "javadocExecutable", 2 );
 639  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 );
 640  0
                 append( sb, "", 0 );
 641  
 
 642  0
                 append( sb, "javadocVersion", 2 );
 643  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 644  0
                 append( sb, "", 0 );
 645  
 
 646  0
                 append( sb, "keywords (Default: false)", 2 );
 647  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 );
 648  0
                 append( sb, "", 0 );
 649  
 
 650  0
                 append( sb, "links", 2 );
 651  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 652  0
                 append( sb, "", 0 );
 653  
 
 654  0
                 append( sb, "linksource (Default: false)", 2 );
 655  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 );
 656  0
                 append( sb, "", 0 );
 657  
 
 658  0
                 append( sb, "locale", 2 );
 659  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 660  0
                 append( sb, "", 0 );
 661  
 
 662  0
                 append( sb, "localRepository", 2 );
 663  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 664  0
                 append( sb, "", 0 );
 665  
 
 666  0
                 append( sb, "maxmemory", 2 );
 667  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 );
 668  0
                 append( sb, "", 0 );
 669  
 
 670  0
                 append( sb, "minmemory", 2 );
 671  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 );
 672  0
                 append( sb, "", 0 );
 673  
 
 674  0
                 append( sb, "nocomment (Default: false)", 2 );
 675  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 );
 676  0
                 append( sb, "", 0 );
 677  
 
 678  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 679  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 680  0
                 append( sb, "", 0 );
 681  
 
 682  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 683  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 );
 684  0
                 append( sb, "", 0 );
 685  
 
 686  0
                 append( sb, "nohelp (Default: false)", 2 );
 687  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 );
 688  0
                 append( sb, "", 0 );
 689  
 
 690  0
                 append( sb, "noindex (Default: false)", 2 );
 691  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 692  0
                 append( sb, "", 0 );
 693  
 
 694  0
                 append( sb, "nonavbar (Default: false)", 2 );
 695  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 696  0
                 append( sb, "", 0 );
 697  
 
 698  0
                 append( sb, "nooverview (Default: false)", 2 );
 699  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 );
 700  0
                 append( sb, "", 0 );
 701  
 
 702  0
                 append( sb, "noqualifier", 2 );
 703  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 );
 704  0
                 append( sb, "", 0 );
 705  
 
 706  0
                 append( sb, "nosince (Default: false)", 2 );
 707  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 708  0
                 append( sb, "", 0 );
 709  
 
 710  0
                 append( sb, "notimestamp (Default: false)", 2 );
 711  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 );
 712  0
                 append( sb, "", 0 );
 713  
 
 714  0
                 append( sb, "notree (Default: false)", 2 );
 715  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 716  0
                 append( sb, "", 0 );
 717  
 
 718  0
                 append( sb, "offlineLinks", 2 );
 719  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://java.sun.com/j2se/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 );
 720  0
                 append( sb, "", 0 );
 721  
 
 722  0
                 append( sb, "old (Default: false)", 2 );
 723  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 724  0
                 append( sb, "", 0 );
 725  
 
 726  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 727  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 728  0
                 append( sb, "", 0 );
 729  
 
 730  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 731  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 );
 732  0
                 append( sb, "", 0 );
 733  
 
 734  0
                 append( sb, "packagesheader", 2 );
 735  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 736  0
                 append( sb, "", 0 );
 737  
 
 738  0
                 append( sb, "proxyHost", 2 );
 739  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 740  0
                 append( sb, "", 0 );
 741  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 );
 742  0
                 append( sb, "", 0 );
 743  
 
 744  0
                 append( sb, "proxyPort", 2 );
 745  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 746  0
                 append( sb, "", 0 );
 747  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 );
 748  0
                 append( sb, "", 0 );
 749  
 
 750  0
                 append( sb, "quiet (Default: false)", 2 );
 751  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 );
 752  0
                 append( sb, "", 0 );
 753  
 
 754  0
                 append( sb, "remoteRepositories", 2 );
 755  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 756  0
                 append( sb, "", 0 );
 757  
 
 758  0
                 append( sb, "resourcesArtifacts", 2 );
 759  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 );
 760  0
                 append( sb, "", 0 );
 761  
 
 762  0
                 append( sb, "serialwarn (Default: false)", 2 );
 763  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 764  0
                 append( sb, "", 0 );
 765  
 
 766  0
                 append( sb, "show (Default: protected)", 2 );
 767  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 );
 768  0
                 append( sb, "", 0 );
 769  
 
 770  0
                 append( sb, "skip (Default: false)", 2 );
 771  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 772  0
                 append( sb, "", 0 );
 773  
 
 774  0
                 append( sb, "source", 2 );
 775  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 );
 776  0
                 append( sb, "", 0 );
 777  
 
 778  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 779  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 780  0
                 append( sb, "", 0 );
 781  
 
 782  0
                 append( sb, "sourcepath", 2 );
 783  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 );
 784  0
                 append( sb, "", 0 );
 785  
 
 786  0
                 append( sb, "sourcetab", 2 );
 787  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 );
 788  0
                 append( sb, "", 0 );
 789  
 
 790  0
                 append( sb, "splitindex (Default: false)", 2 );
 791  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 );
 792  0
                 append( sb, "", 0 );
 793  
 
 794  0
                 append( sb, "stylesheet (Default: java)", 2 );
 795  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 );
 796  0
                 append( sb, "", 0 );
 797  
 
 798  0
                 append( sb, "stylesheetfile", 2 );
 799  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 );
 800  0
                 append( sb, "", 0 );
 801  
 
 802  0
                 append( sb, "subpackages", 2 );
 803  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 );
 804  0
                 append( sb, "", 0 );
 805  
 
 806  0
                 append( sb, "taglet", 2 );
 807  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 );
 808  0
                 append( sb, "", 0 );
 809  
 
 810  0
                 append( sb, "tagletArtifact", 2 );
 811  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 );
 812  0
                 append( sb, "", 0 );
 813  
 
 814  0
                 append( sb, "tagletArtifacts", 2 );
 815  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 );
 816  0
                 append( sb, "", 0 );
 817  
 
 818  0
                 append( sb, "tagletpath", 2 );
 819  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 );
 820  0
                 append( sb, "", 0 );
 821  
 
 822  0
                 append( sb, "taglets", 2 );
 823  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 );
 824  0
                 append( sb, "", 0 );
 825  
 
 826  0
                 append( sb, "tags", 2 );
 827  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 );
 828  0
                 append( sb, "", 0 );
 829  
 
 830  0
                 append( sb, "top", 2 );
 831  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 832  0
                 append( sb, "", 0 );
 833  
 
 834  0
                 append( sb, "use (Default: true)", 2 );
 835  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 836  0
                 append( sb, "", 0 );
 837  
 
 838  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 839  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 840  0
                 append( sb, "", 0 );
 841  
 
 842  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 843  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 );
 844  0
                 append( sb, "", 0 );
 845  
 
 846  0
                 append( sb, "verbose (Default: false)", 2 );
 847  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 848  0
                 append( sb, "", 0 );
 849  
 
 850  0
                 append( sb, "version (Default: true)", 2 );
 851  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 852  0
                 append( sb, "", 0 );
 853  
 
 854  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 855  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 856  0
                 append( sb, "", 0 );
 857  
             }
 858  
         }
 859  
 
 860  0
         if ( goal == null || goal.length() <= 0 || "fix".equals( goal ) )
 861  
         {
 862  0
             append( sb, "javadoc:fix", 0 );
 863  0
             append( sb, "Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.", 1 );
 864  0
             append( sb, "", 0 );
 865  0
             if ( detail )
 866  
             {
 867  0
                 append( sb, "Available parameters:", 1 );
 868  0
                 append( sb, "", 0 );
 869  
 
 870  0
                 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
 871  0
                 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
 872  0
                 append( sb, "", 0 );
 873  
 
 874  0
                 append( sb, "defaultAuthor", 2 );
 875  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 );
 876  0
                 append( sb, "", 0 );
 877  
 
 878  0
                 append( sb, "defaultSince (Default: ${project.version})", 2 );
 879  0
                 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
 880  0
                 append( sb, "", 0 );
 881  
 
 882  0
                 append( sb, "defaultVersion", 2 );
 883  0
                 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id: org.apache.maven.plugin.javadoc.HelpMojo.html 829396 2012-08-19 17:35:19Z hboutemy $, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
 884  0
                 append( sb, "", 0 );
 885  
 
 886  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 887  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 );
 888  0
                 append( sb, "", 0 );
 889  
 
 890  0
                 append( sb, "excludes", 2 );
 891  0
                 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
 892  0
                 append( sb, "", 0 );
 893  
 
 894  0
                 append( sb, "fixClassComment (Default: true)", 2 );
 895  0
                 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
 896  0
                 append( sb, "", 0 );
 897  
 
 898  0
                 append( sb, "fixFieldComment (Default: true)", 2 );
 899  0
                 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
 900  0
                 append( sb, "", 0 );
 901  
 
 902  0
                 append( sb, "fixMethodComment (Default: true)", 2 );
 903  0
                 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
 904  0
                 append( sb, "", 0 );
 905  
 
 906  0
                 append( sb, "fixTags (Default: all)", 2 );
 907  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 );
 908  0
                 append( sb, "", 0 );
 909  
 
 910  0
                 append( sb, "force", 2 );
 911  0
                 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
 912  0
                 append( sb, "", 0 );
 913  
 
 914  0
                 append( sb, "ignoreClirr (Default: false)", 2 );
 915  0
                 append( sb, "Flag to ignore or not Clirr.", 3 );
 916  0
                 append( sb, "", 0 );
 917  
 
 918  0
                 append( sb, "includes (Default: **/*.java)", 2 );
 919  0
                 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
 920  0
                 append( sb, "", 0 );
 921  
 
 922  0
                 append( sb, "level (Default: protected)", 2 );
 923  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 );
 924  0
                 append( sb, "", 0 );
 925  
 
 926  0
                 append( sb, "localRepository", 2 );
 927  0
                 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
 928  0
                 append( sb, "", 0 );
 929  
 
 930  0
                 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
 931  0
                 append( sb, "Output directory where Java classes will be rewrited.", 3 );
 932  0
                 append( sb, "", 0 );
 933  
             }
 934  
         }
 935  
 
 936  0
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 937  
         {
 938  0
             append( sb, "javadoc:help", 0 );
 939  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 );
 940  0
             append( sb, "", 0 );
 941  0
             if ( detail )
 942  
             {
 943  0
                 append( sb, "Available parameters:", 1 );
 944  0
                 append( sb, "", 0 );
 945  
 
 946  0
                 append( sb, "detail (Default: false)", 2 );
 947  0
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 948  0
                 append( sb, "", 0 );
 949  
 
 950  0
                 append( sb, "goal", 2 );
 951  0
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 952  0
                 append( sb, "", 0 );
 953  
 
 954  0
                 append( sb, "indentSize (Default: 2)", 2 );
 955  0
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 956  0
                 append( sb, "", 0 );
 957  
 
 958  0
                 append( sb, "lineLength (Default: 80)", 2 );
 959  0
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 960  0
                 append( sb, "", 0 );
 961  
             }
 962  
         }
 963  
 
 964  0
         if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )
 965  
         {
 966  0
             append( sb, "javadoc:jar", 0 );
 967  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 );
 968  0
             append( sb, "", 0 );
 969  0
             if ( detail )
 970  
             {
 971  0
                 append( sb, "Available parameters:", 1 );
 972  0
                 append( sb, "", 0 );
 973  
 
 974  0
                 append( sb, "additionalJOption", 2 );
 975  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 );
 976  0
                 append( sb, "", 0 );
 977  
 
 978  0
                 append( sb, "additionalparam", 2 );
 979  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 );
 980  0
                 append( sb, "", 0 );
 981  
 
 982  0
                 append( sb, "aggregate (Default: false)", 2 );
 983  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 984  0
                 append( sb, "", 0 );
 985  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 986  0
                 append( sb, "", 0 );
 987  
 
 988  0
                 append( sb, "archive", 2 );
 989  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 990  0
                 append( sb, "", 0 );
 991  
 
 992  0
                 append( sb, "attach (Default: true)", 2 );
 993  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 994  0
                 append( sb, "", 0 );
 995  
 
 996  0
                 append( sb, "author (Default: true)", 2 );
 997  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 998  0
                 append( sb, "", 0 );
 999  
 
 1000  0
                 append( sb, "bootclasspath", 2 );
 1001  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 );
 1002  0
                 append( sb, "", 0 );
 1003  
 
 1004  0
                 append( sb, "bootclasspathArtifacts", 2 );
 1005  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 );
 1006  0
                 append( sb, "", 0 );
 1007  
 
 1008  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1009  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 );
 1010  0
                 append( sb, "", 0 );
 1011  
 
 1012  0
                 append( sb, "breakiterator (Default: false)", 2 );
 1013  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1014  0
                 append( sb, "", 0 );
 1015  
 
 1016  0
                 append( sb, "charset", 2 );
 1017  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 );
 1018  0
                 append( sb, "", 0 );
 1019  
 
 1020  0
                 append( sb, "debug (Default: false)", 2 );
 1021  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 );
 1022  0
                 append( sb, "", 0 );
 1023  
 
 1024  0
                 append( sb, "dependencySourceExcludes", 2 );
 1025  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 1026  0
                 append( sb, "", 0 );
 1027  
 
 1028  0
                 append( sb, "dependencySourceIncludes", 2 );
 1029  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 1030  0
                 append( sb, "", 0 );
 1031  
 
 1032  0
                 append( sb, "destDir", 2 );
 1033  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 1034  0
                 append( sb, "", 0 );
 1035  
 
 1036  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 1037  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 1038  0
                 append( sb, "", 0 );
 1039  
 
 1040  0
                 append( sb, "detectLinks (Default: false)", 2 );
 1041  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 );
 1042  0
                 append( sb, "", 0 );
 1043  
 
 1044  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 1045  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 );
 1046  0
                 append( sb, "", 0 );
 1047  
 
 1048  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1049  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1050  0
                 append( sb, "", 0 );
 1051  
 
 1052  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1053  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 );
 1054  0
                 append( sb, "", 0 );
 1055  
 
 1056  0
                 append( sb, "doclet", 2 );
 1057  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1058  0
                 append( sb, "", 0 );
 1059  
 
 1060  0
                 append( sb, "docletArtifact", 2 );
 1061  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 );
 1062  0
                 append( sb, "", 0 );
 1063  
 
 1064  0
                 append( sb, "docletArtifacts", 2 );
 1065  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 );
 1066  0
                 append( sb, "", 0 );
 1067  
 
 1068  0
                 append( sb, "docletPath", 2 );
 1069  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 );
 1070  0
                 append( sb, "", 0 );
 1071  
 
 1072  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1073  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1074  0
                 append( sb, "", 0 );
 1075  
 
 1076  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1077  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 );
 1078  0
                 append( sb, "", 0 );
 1079  
 
 1080  0
                 append( sb, "excludedocfilessubdir", 2 );
 1081  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 );
 1082  0
                 append( sb, "", 0 );
 1083  
 
 1084  0
                 append( sb, "excludePackageNames", 2 );
 1085  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 );
 1086  0
                 append( sb, "", 0 );
 1087  
 
 1088  0
                 append( sb, "extdirs", 2 );
 1089  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 1090  0
                 append( sb, "", 0 );
 1091  
 
 1092  0
                 append( sb, "failOnError (Default: true)", 2 );
 1093  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 1094  0
                 append( sb, "", 0 );
 1095  
 
 1096  0
                 append( sb, "finalName", 2 );
 1097  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 );
 1098  0
                 append( sb, "", 0 );
 1099  
 
 1100  0
                 append( sb, "footer", 2 );
 1101  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1102  0
                 append( sb, "", 0 );
 1103  
 
 1104  0
                 append( sb, "groups", 2 );
 1105  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 );
 1106  0
                 append( sb, "", 0 );
 1107  
 
 1108  0
                 append( sb, "header", 2 );
 1109  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1110  0
                 append( sb, "", 0 );
 1111  
 
 1112  0
                 append( sb, "helpfile", 2 );
 1113  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 );
 1114  0
                 append( sb, "", 0 );
 1115  
 
 1116  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 1117  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 );
 1118  0
                 append( sb, "", 0 );
 1119  
 
 1120  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 1121  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 1122  0
                 append( sb, "", 0 );
 1123  
 
 1124  0
                 append( sb, "jarOutputDirectory", 2 );
 1125  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 1126  0
                 append( sb, "", 0 );
 1127  
 
 1128  0
                 append( sb, "javaApiLinks", 2 );
 1129  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 );
 1130  0
                 append( sb, "", 0 );
 1131  
 
 1132  0
                 append( sb, "javadocDirectory", 2 );
 1133  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 );
 1134  0
                 append( sb, "", 0 );
 1135  
 
 1136  0
                 append( sb, "javadocExecutable", 2 );
 1137  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 );
 1138  0
                 append( sb, "", 0 );
 1139  
 
 1140  0
                 append( sb, "javadocVersion", 2 );
 1141  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1142  0
                 append( sb, "", 0 );
 1143  
 
 1144  0
                 append( sb, "keywords (Default: false)", 2 );
 1145  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 );
 1146  0
                 append( sb, "", 0 );
 1147  
 
 1148  0
                 append( sb, "links", 2 );
 1149  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 1150  0
                 append( sb, "", 0 );
 1151  
 
 1152  0
                 append( sb, "linksource (Default: false)", 2 );
 1153  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 );
 1154  0
                 append( sb, "", 0 );
 1155  
 
 1156  0
                 append( sb, "locale", 2 );
 1157  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1158  0
                 append( sb, "", 0 );
 1159  
 
 1160  0
                 append( sb, "localRepository", 2 );
 1161  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1162  0
                 append( sb, "", 0 );
 1163  
 
 1164  0
                 append( sb, "maxmemory", 2 );
 1165  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 );
 1166  0
                 append( sb, "", 0 );
 1167  
 
 1168  0
                 append( sb, "minmemory", 2 );
 1169  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 );
 1170  0
                 append( sb, "", 0 );
 1171  
 
 1172  0
                 append( sb, "nocomment (Default: false)", 2 );
 1173  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 );
 1174  0
                 append( sb, "", 0 );
 1175  
 
 1176  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 1177  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1178  0
                 append( sb, "", 0 );
 1179  
 
 1180  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1181  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 );
 1182  0
                 append( sb, "", 0 );
 1183  
 
 1184  0
                 append( sb, "nohelp (Default: false)", 2 );
 1185  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 );
 1186  0
                 append( sb, "", 0 );
 1187  
 
 1188  0
                 append( sb, "noindex (Default: false)", 2 );
 1189  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1190  0
                 append( sb, "", 0 );
 1191  
 
 1192  0
                 append( sb, "nonavbar (Default: false)", 2 );
 1193  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1194  0
                 append( sb, "", 0 );
 1195  
 
 1196  0
                 append( sb, "nooverview (Default: false)", 2 );
 1197  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 );
 1198  0
                 append( sb, "", 0 );
 1199  
 
 1200  0
                 append( sb, "noqualifier", 2 );
 1201  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 );
 1202  0
                 append( sb, "", 0 );
 1203  
 
 1204  0
                 append( sb, "nosince (Default: false)", 2 );
 1205  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1206  0
                 append( sb, "", 0 );
 1207  
 
 1208  0
                 append( sb, "notimestamp (Default: false)", 2 );
 1209  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 );
 1210  0
                 append( sb, "", 0 );
 1211  
 
 1212  0
                 append( sb, "notree (Default: false)", 2 );
 1213  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1214  0
                 append( sb, "", 0 );
 1215  
 
 1216  0
                 append( sb, "offlineLinks", 2 );
 1217  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://java.sun.com/j2se/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 );
 1218  0
                 append( sb, "", 0 );
 1219  
 
 1220  0
                 append( sb, "old (Default: false)", 2 );
 1221  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1222  0
                 append( sb, "", 0 );
 1223  
 
 1224  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1225  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1226  0
                 append( sb, "", 0 );
 1227  
 
 1228  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1229  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 );
 1230  0
                 append( sb, "", 0 );
 1231  
 
 1232  0
                 append( sb, "packagesheader", 2 );
 1233  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1234  0
                 append( sb, "", 0 );
 1235  
 
 1236  0
                 append( sb, "proxyHost", 2 );
 1237  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1238  0
                 append( sb, "", 0 );
 1239  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 );
 1240  0
                 append( sb, "", 0 );
 1241  
 
 1242  0
                 append( sb, "proxyPort", 2 );
 1243  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1244  0
                 append( sb, "", 0 );
 1245  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 );
 1246  0
                 append( sb, "", 0 );
 1247  
 
 1248  0
                 append( sb, "quiet (Default: false)", 2 );
 1249  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 );
 1250  0
                 append( sb, "", 0 );
 1251  
 
 1252  0
                 append( sb, "remoteRepositories", 2 );
 1253  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1254  0
                 append( sb, "", 0 );
 1255  
 
 1256  0
                 append( sb, "resourcesArtifacts", 2 );
 1257  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 );
 1258  0
                 append( sb, "", 0 );
 1259  
 
 1260  0
                 append( sb, "serialwarn (Default: false)", 2 );
 1261  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1262  0
                 append( sb, "", 0 );
 1263  
 
 1264  0
                 append( sb, "show (Default: protected)", 2 );
 1265  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 );
 1266  0
                 append( sb, "", 0 );
 1267  
 
 1268  0
                 append( sb, "skip (Default: false)", 2 );
 1269  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1270  0
                 append( sb, "", 0 );
 1271  
 
 1272  0
                 append( sb, "source", 2 );
 1273  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 );
 1274  0
                 append( sb, "", 0 );
 1275  
 
 1276  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 1277  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 1278  0
                 append( sb, "", 0 );
 1279  
 
 1280  0
                 append( sb, "sourcepath", 2 );
 1281  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 );
 1282  0
                 append( sb, "", 0 );
 1283  
 
 1284  0
                 append( sb, "sourcetab", 2 );
 1285  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 );
 1286  0
                 append( sb, "", 0 );
 1287  
 
 1288  0
                 append( sb, "splitindex (Default: false)", 2 );
 1289  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 );
 1290  0
                 append( sb, "", 0 );
 1291  
 
 1292  0
                 append( sb, "stylesheet (Default: java)", 2 );
 1293  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 );
 1294  0
                 append( sb, "", 0 );
 1295  
 
 1296  0
                 append( sb, "stylesheetfile", 2 );
 1297  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 );
 1298  0
                 append( sb, "", 0 );
 1299  
 
 1300  0
                 append( sb, "subpackages", 2 );
 1301  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 );
 1302  0
                 append( sb, "", 0 );
 1303  
 
 1304  0
                 append( sb, "taglet", 2 );
 1305  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 );
 1306  0
                 append( sb, "", 0 );
 1307  
 
 1308  0
                 append( sb, "tagletArtifact", 2 );
 1309  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 );
 1310  0
                 append( sb, "", 0 );
 1311  
 
 1312  0
                 append( sb, "tagletArtifacts", 2 );
 1313  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 );
 1314  0
                 append( sb, "", 0 );
 1315  
 
 1316  0
                 append( sb, "tagletpath", 2 );
 1317  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 );
 1318  0
                 append( sb, "", 0 );
 1319  
 
 1320  0
                 append( sb, "taglets", 2 );
 1321  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 );
 1322  0
                 append( sb, "", 0 );
 1323  
 
 1324  0
                 append( sb, "tags", 2 );
 1325  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 );
 1326  0
                 append( sb, "", 0 );
 1327  
 
 1328  0
                 append( sb, "top", 2 );
 1329  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1330  0
                 append( sb, "", 0 );
 1331  
 
 1332  0
                 append( sb, "use (Default: true)", 2 );
 1333  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1334  0
                 append( sb, "", 0 );
 1335  
 
 1336  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 1337  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 1338  0
                 append( sb, "", 0 );
 1339  
 
 1340  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1341  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 );
 1342  0
                 append( sb, "", 0 );
 1343  
 
 1344  0
                 append( sb, "verbose (Default: false)", 2 );
 1345  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1346  0
                 append( sb, "", 0 );
 1347  
 
 1348  0
                 append( sb, "version (Default: true)", 2 );
 1349  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1350  0
                 append( sb, "", 0 );
 1351  
 
 1352  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1353  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1354  0
                 append( sb, "", 0 );
 1355  
             }
 1356  
         }
 1357  
 
 1358  0
         if ( goal == null || goal.length() <= 0 || "javadoc".equals( goal ) )
 1359  
         {
 1360  0
             append( sb, "javadoc:javadoc", 0 );
 1361  0
             append( sb, "Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.", 1 );
 1362  0
             append( sb, "", 0 );
 1363  0
             if ( detail )
 1364  
             {
 1365  0
                 append( sb, "Available parameters:", 1 );
 1366  0
                 append( sb, "", 0 );
 1367  
 
 1368  0
                 append( sb, "additionalJOption", 2 );
 1369  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 );
 1370  0
                 append( sb, "", 0 );
 1371  
 
 1372  0
                 append( sb, "additionalparam", 2 );
 1373  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 );
 1374  0
                 append( sb, "", 0 );
 1375  
 
 1376  0
                 append( sb, "aggregate (Default: false)", 2 );
 1377  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1378  0
                 append( sb, "", 0 );
 1379  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1380  0
                 append( sb, "", 0 );
 1381  
 
 1382  0
                 append( sb, "author (Default: true)", 2 );
 1383  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1384  0
                 append( sb, "", 0 );
 1385  
 
 1386  0
                 append( sb, "bootclasspath", 2 );
 1387  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 );
 1388  0
                 append( sb, "", 0 );
 1389  
 
 1390  0
                 append( sb, "bootclasspathArtifacts", 2 );
 1391  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 );
 1392  0
                 append( sb, "", 0 );
 1393  
 
 1394  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1395  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 );
 1396  0
                 append( sb, "", 0 );
 1397  
 
 1398  0
                 append( sb, "breakiterator (Default: false)", 2 );
 1399  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1400  0
                 append( sb, "", 0 );
 1401  
 
 1402  0
                 append( sb, "charset", 2 );
 1403  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 );
 1404  0
                 append( sb, "", 0 );
 1405  
 
 1406  0
                 append( sb, "debug (Default: false)", 2 );
 1407  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 );
 1408  0
                 append( sb, "", 0 );
 1409  
 
 1410  0
                 append( sb, "dependencySourceExcludes", 2 );
 1411  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 1412  0
                 append( sb, "", 0 );
 1413  
 
 1414  0
                 append( sb, "dependencySourceIncludes", 2 );
 1415  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 1416  0
                 append( sb, "", 0 );
 1417  
 
 1418  0
                 append( sb, "description", 2 );
 1419  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 1420  0
                 append( sb, "", 0 );
 1421  
 
 1422  0
                 append( sb, "destDir (Default: apidocs)", 2 );
 1423  0
                 append( sb, "The name of the destination directory.\n", 3 );
 1424  0
                 append( sb, "", 0 );
 1425  
 
 1426  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 1427  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 1428  0
                 append( sb, "", 0 );
 1429  
 
 1430  0
                 append( sb, "detectLinks (Default: false)", 2 );
 1431  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 );
 1432  0
                 append( sb, "", 0 );
 1433  
 
 1434  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 1435  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 );
 1436  0
                 append( sb, "", 0 );
 1437  
 
 1438  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1439  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1440  0
                 append( sb, "", 0 );
 1441  
 
 1442  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1443  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 );
 1444  0
                 append( sb, "", 0 );
 1445  
 
 1446  0
                 append( sb, "doclet", 2 );
 1447  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1448  0
                 append( sb, "", 0 );
 1449  
 
 1450  0
                 append( sb, "docletArtifact", 2 );
 1451  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 );
 1452  0
                 append( sb, "", 0 );
 1453  
 
 1454  0
                 append( sb, "docletArtifacts", 2 );
 1455  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 );
 1456  0
                 append( sb, "", 0 );
 1457  
 
 1458  0
                 append( sb, "docletPath", 2 );
 1459  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 );
 1460  0
                 append( sb, "", 0 );
 1461  
 
 1462  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1463  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1464  0
                 append( sb, "", 0 );
 1465  
 
 1466  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1467  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 );
 1468  0
                 append( sb, "", 0 );
 1469  
 
 1470  0
                 append( sb, "excludedocfilessubdir", 2 );
 1471  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 );
 1472  0
                 append( sb, "", 0 );
 1473  
 
 1474  0
                 append( sb, "excludePackageNames", 2 );
 1475  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 );
 1476  0
                 append( sb, "", 0 );
 1477  
 
 1478  0
                 append( sb, "extdirs", 2 );
 1479  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 1480  0
                 append( sb, "", 0 );
 1481  
 
 1482  0
                 append( sb, "failOnError (Default: true)", 2 );
 1483  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 1484  0
                 append( sb, "", 0 );
 1485  
 
 1486  0
                 append( sb, "footer", 2 );
 1487  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1488  0
                 append( sb, "", 0 );
 1489  
 
 1490  0
                 append( sb, "groups", 2 );
 1491  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 );
 1492  0
                 append( sb, "", 0 );
 1493  
 
 1494  0
                 append( sb, "header", 2 );
 1495  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1496  0
                 append( sb, "", 0 );
 1497  
 
 1498  0
                 append( sb, "helpfile", 2 );
 1499  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 );
 1500  0
                 append( sb, "", 0 );
 1501  
 
 1502  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 1503  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 );
 1504  0
                 append( sb, "", 0 );
 1505  
 
 1506  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 1507  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 1508  0
                 append( sb, "", 0 );
 1509  
 
 1510  0
                 append( sb, "javaApiLinks", 2 );
 1511  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 );
 1512  0
                 append( sb, "", 0 );
 1513  
 
 1514  0
                 append( sb, "javadocDirectory", 2 );
 1515  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 );
 1516  0
                 append( sb, "", 0 );
 1517  
 
 1518  0
                 append( sb, "javadocExecutable", 2 );
 1519  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 );
 1520  0
                 append( sb, "", 0 );
 1521  
 
 1522  0
                 append( sb, "javadocVersion", 2 );
 1523  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1524  0
                 append( sb, "", 0 );
 1525  
 
 1526  0
                 append( sb, "keywords (Default: false)", 2 );
 1527  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 );
 1528  0
                 append( sb, "", 0 );
 1529  
 
 1530  0
                 append( sb, "links", 2 );
 1531  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 1532  0
                 append( sb, "", 0 );
 1533  
 
 1534  0
                 append( sb, "linksource (Default: false)", 2 );
 1535  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 );
 1536  0
                 append( sb, "", 0 );
 1537  
 
 1538  0
                 append( sb, "locale", 2 );
 1539  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1540  0
                 append( sb, "", 0 );
 1541  
 
 1542  0
                 append( sb, "localRepository", 2 );
 1543  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1544  0
                 append( sb, "", 0 );
 1545  
 
 1546  0
                 append( sb, "maxmemory", 2 );
 1547  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 );
 1548  0
                 append( sb, "", 0 );
 1549  
 
 1550  0
                 append( sb, "minmemory", 2 );
 1551  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 );
 1552  0
                 append( sb, "", 0 );
 1553  
 
 1554  0
                 append( sb, "name", 2 );
 1555  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 1556  0
                 append( sb, "", 0 );
 1557  
 
 1558  0
                 append( sb, "nocomment (Default: false)", 2 );
 1559  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 );
 1560  0
                 append( sb, "", 0 );
 1561  
 
 1562  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 1563  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1564  0
                 append( sb, "", 0 );
 1565  
 
 1566  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1567  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 );
 1568  0
                 append( sb, "", 0 );
 1569  
 
 1570  0
                 append( sb, "nohelp (Default: false)", 2 );
 1571  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 );
 1572  0
                 append( sb, "", 0 );
 1573  
 
 1574  0
                 append( sb, "noindex (Default: false)", 2 );
 1575  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1576  0
                 append( sb, "", 0 );
 1577  
 
 1578  0
                 append( sb, "nonavbar (Default: false)", 2 );
 1579  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1580  0
                 append( sb, "", 0 );
 1581  
 
 1582  0
                 append( sb, "nooverview (Default: false)", 2 );
 1583  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 );
 1584  0
                 append( sb, "", 0 );
 1585  
 
 1586  0
                 append( sb, "noqualifier", 2 );
 1587  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 );
 1588  0
                 append( sb, "", 0 );
 1589  
 
 1590  0
                 append( sb, "nosince (Default: false)", 2 );
 1591  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1592  0
                 append( sb, "", 0 );
 1593  
 
 1594  0
                 append( sb, "notimestamp (Default: false)", 2 );
 1595  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 );
 1596  0
                 append( sb, "", 0 );
 1597  
 
 1598  0
                 append( sb, "notree (Default: false)", 2 );
 1599  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1600  0
                 append( sb, "", 0 );
 1601  
 
 1602  0
                 append( sb, "offlineLinks", 2 );
 1603  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://java.sun.com/j2se/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 );
 1604  0
                 append( sb, "", 0 );
 1605  
 
 1606  0
                 append( sb, "old (Default: false)", 2 );
 1607  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1608  0
                 append( sb, "", 0 );
 1609  
 
 1610  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1611  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1612  0
                 append( sb, "", 0 );
 1613  
 
 1614  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1615  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 );
 1616  0
                 append( sb, "", 0 );
 1617  
 
 1618  0
                 append( sb, "packagesheader", 2 );
 1619  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1620  0
                 append( sb, "", 0 );
 1621  
 
 1622  0
                 append( sb, "proxyHost", 2 );
 1623  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1624  0
                 append( sb, "", 0 );
 1625  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 );
 1626  0
                 append( sb, "", 0 );
 1627  
 
 1628  0
                 append( sb, "proxyPort", 2 );
 1629  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1630  0
                 append( sb, "", 0 );
 1631  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 );
 1632  0
                 append( sb, "", 0 );
 1633  
 
 1634  0
                 append( sb, "quiet (Default: false)", 2 );
 1635  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 );
 1636  0
                 append( sb, "", 0 );
 1637  
 
 1638  0
                 append( sb, "remoteRepositories", 2 );
 1639  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1640  0
                 append( sb, "", 0 );
 1641  
 
 1642  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
 1643  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 1644  0
                 append( sb, "", 0 );
 1645  
 
 1646  0
                 append( sb, "resourcesArtifacts", 2 );
 1647  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 );
 1648  0
                 append( sb, "", 0 );
 1649  
 
 1650  0
                 append( sb, "serialwarn (Default: false)", 2 );
 1651  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1652  0
                 append( sb, "", 0 );
 1653  
 
 1654  0
                 append( sb, "show (Default: protected)", 2 );
 1655  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 );
 1656  0
                 append( sb, "", 0 );
 1657  
 
 1658  0
                 append( sb, "skip (Default: false)", 2 );
 1659  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1660  0
                 append( sb, "", 0 );
 1661  
 
 1662  0
                 append( sb, "source", 2 );
 1663  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 );
 1664  0
                 append( sb, "", 0 );
 1665  
 
 1666  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 1667  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 1668  0
                 append( sb, "", 0 );
 1669  
 
 1670  0
                 append( sb, "sourcepath", 2 );
 1671  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 );
 1672  0
                 append( sb, "", 0 );
 1673  
 
 1674  0
                 append( sb, "sourcetab", 2 );
 1675  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 );
 1676  0
                 append( sb, "", 0 );
 1677  
 
 1678  0
                 append( sb, "splitindex (Default: false)", 2 );
 1679  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 );
 1680  0
                 append( sb, "", 0 );
 1681  
 
 1682  0
                 append( sb, "stylesheet (Default: java)", 2 );
 1683  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 );
 1684  0
                 append( sb, "", 0 );
 1685  
 
 1686  0
                 append( sb, "stylesheetfile", 2 );
 1687  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 );
 1688  0
                 append( sb, "", 0 );
 1689  
 
 1690  0
                 append( sb, "subpackages", 2 );
 1691  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 );
 1692  0
                 append( sb, "", 0 );
 1693  
 
 1694  0
                 append( sb, "taglet", 2 );
 1695  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 );
 1696  0
                 append( sb, "", 0 );
 1697  
 
 1698  0
                 append( sb, "tagletArtifact", 2 );
 1699  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 );
 1700  0
                 append( sb, "", 0 );
 1701  
 
 1702  0
                 append( sb, "tagletArtifacts", 2 );
 1703  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 );
 1704  0
                 append( sb, "", 0 );
 1705  
 
 1706  0
                 append( sb, "tagletpath", 2 );
 1707  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 );
 1708  0
                 append( sb, "", 0 );
 1709  
 
 1710  0
                 append( sb, "taglets", 2 );
 1711  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 );
 1712  0
                 append( sb, "", 0 );
 1713  
 
 1714  0
                 append( sb, "tags", 2 );
 1715  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 );
 1716  0
                 append( sb, "", 0 );
 1717  
 
 1718  0
                 append( sb, "top", 2 );
 1719  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1720  0
                 append( sb, "", 0 );
 1721  
 
 1722  0
                 append( sb, "use (Default: true)", 2 );
 1723  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1724  0
                 append( sb, "", 0 );
 1725  
 
 1726  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1727  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 );
 1728  0
                 append( sb, "", 0 );
 1729  
 
 1730  0
                 append( sb, "verbose (Default: false)", 2 );
 1731  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1732  0
                 append( sb, "", 0 );
 1733  
 
 1734  0
                 append( sb, "version (Default: true)", 2 );
 1735  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1736  0
                 append( sb, "", 0 );
 1737  
 
 1738  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1739  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1740  0
                 append( sb, "", 0 );
 1741  
             }
 1742  
         }
 1743  
 
 1744  0
         if ( goal == null || goal.length() <= 0 || "resource-bundle".equals( goal ) )
 1745  
         {
 1746  0
             append( sb, "javadoc:resource-bundle", 0 );
 1747  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 );
 1748  0
             append( sb, "", 0 );
 1749  0
             if ( detail )
 1750  
             {
 1751  0
                 append( sb, "Available parameters:", 1 );
 1752  0
                 append( sb, "", 0 );
 1753  
 
 1754  0
                 append( sb, "additionalJOption", 2 );
 1755  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 );
 1756  0
                 append( sb, "", 0 );
 1757  
 
 1758  0
                 append( sb, "additionalparam", 2 );
 1759  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 );
 1760  0
                 append( sb, "", 0 );
 1761  
 
 1762  0
                 append( sb, "aggregate (Default: false)", 2 );
 1763  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1764  0
                 append( sb, "", 0 );
 1765  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1766  0
                 append( sb, "", 0 );
 1767  
 
 1768  0
                 append( sb, "author (Default: true)", 2 );
 1769  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1770  0
                 append( sb, "", 0 );
 1771  
 
 1772  0
                 append( sb, "bootclasspath", 2 );
 1773  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 );
 1774  0
                 append( sb, "", 0 );
 1775  
 
 1776  0
                 append( sb, "bootclasspathArtifacts", 2 );
 1777  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 );
 1778  0
                 append( sb, "", 0 );
 1779  
 
 1780  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1781  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 );
 1782  0
                 append( sb, "", 0 );
 1783  
 
 1784  0
                 append( sb, "breakiterator (Default: false)", 2 );
 1785  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1786  0
                 append( sb, "", 0 );
 1787  
 
 1788  0
                 append( sb, "charset", 2 );
 1789  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 );
 1790  0
                 append( sb, "", 0 );
 1791  
 
 1792  0
                 append( sb, "debug (Default: false)", 2 );
 1793  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 );
 1794  0
                 append( sb, "", 0 );
 1795  
 
 1796  0
                 append( sb, "dependencySourceExcludes", 2 );
 1797  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 1798  0
                 append( sb, "", 0 );
 1799  
 
 1800  0
                 append( sb, "dependencySourceIncludes", 2 );
 1801  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 1802  0
                 append( sb, "", 0 );
 1803  
 
 1804  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 1805  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 1806  0
                 append( sb, "", 0 );
 1807  
 
 1808  0
                 append( sb, "detectLinks (Default: false)", 2 );
 1809  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 );
 1810  0
                 append( sb, "", 0 );
 1811  
 
 1812  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 1813  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 );
 1814  0
                 append( sb, "", 0 );
 1815  
 
 1816  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1817  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1818  0
                 append( sb, "", 0 );
 1819  
 
 1820  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1821  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 );
 1822  0
                 append( sb, "", 0 );
 1823  
 
 1824  0
                 append( sb, "doclet", 2 );
 1825  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1826  0
                 append( sb, "", 0 );
 1827  
 
 1828  0
                 append( sb, "docletArtifact", 2 );
 1829  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 );
 1830  0
                 append( sb, "", 0 );
 1831  
 
 1832  0
                 append( sb, "docletArtifacts", 2 );
 1833  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 );
 1834  0
                 append( sb, "", 0 );
 1835  
 
 1836  0
                 append( sb, "docletPath", 2 );
 1837  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 );
 1838  0
                 append( sb, "", 0 );
 1839  
 
 1840  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1841  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1842  0
                 append( sb, "", 0 );
 1843  
 
 1844  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1845  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 );
 1846  0
                 append( sb, "", 0 );
 1847  
 
 1848  0
                 append( sb, "excludedocfilessubdir", 2 );
 1849  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 );
 1850  0
                 append( sb, "", 0 );
 1851  
 
 1852  0
                 append( sb, "excludePackageNames", 2 );
 1853  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 );
 1854  0
                 append( sb, "", 0 );
 1855  
 
 1856  0
                 append( sb, "extdirs", 2 );
 1857  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 1858  0
                 append( sb, "", 0 );
 1859  
 
 1860  0
                 append( sb, "failOnError (Default: true)", 2 );
 1861  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 1862  0
                 append( sb, "", 0 );
 1863  
 
 1864  0
                 append( sb, "footer", 2 );
 1865  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1866  0
                 append( sb, "", 0 );
 1867  
 
 1868  0
                 append( sb, "groups", 2 );
 1869  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 );
 1870  0
                 append( sb, "", 0 );
 1871  
 
 1872  0
                 append( sb, "header", 2 );
 1873  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1874  0
                 append( sb, "", 0 );
 1875  
 
 1876  0
                 append( sb, "helpfile", 2 );
 1877  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 );
 1878  0
                 append( sb, "", 0 );
 1879  
 
 1880  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 1881  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 );
 1882  0
                 append( sb, "", 0 );
 1883  
 
 1884  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 1885  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 1886  0
                 append( sb, "", 0 );
 1887  
 
 1888  0
                 append( sb, "javaApiLinks", 2 );
 1889  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 );
 1890  0
                 append( sb, "", 0 );
 1891  
 
 1892  0
                 append( sb, "javadocDirectory", 2 );
 1893  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 );
 1894  0
                 append( sb, "", 0 );
 1895  
 
 1896  0
                 append( sb, "javadocExecutable", 2 );
 1897  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 );
 1898  0
                 append( sb, "", 0 );
 1899  
 
 1900  0
                 append( sb, "javadocVersion", 2 );
 1901  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1902  0
                 append( sb, "", 0 );
 1903  
 
 1904  0
                 append( sb, "keywords (Default: false)", 2 );
 1905  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 );
 1906  0
                 append( sb, "", 0 );
 1907  
 
 1908  0
                 append( sb, "links", 2 );
 1909  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 1910  0
                 append( sb, "", 0 );
 1911  
 
 1912  0
                 append( sb, "linksource (Default: false)", 2 );
 1913  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 );
 1914  0
                 append( sb, "", 0 );
 1915  
 
 1916  0
                 append( sb, "locale", 2 );
 1917  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1918  0
                 append( sb, "", 0 );
 1919  
 
 1920  0
                 append( sb, "localRepository", 2 );
 1921  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1922  0
                 append( sb, "", 0 );
 1923  
 
 1924  0
                 append( sb, "maxmemory", 2 );
 1925  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 );
 1926  0
                 append( sb, "", 0 );
 1927  
 
 1928  0
                 append( sb, "minmemory", 2 );
 1929  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 );
 1930  0
                 append( sb, "", 0 );
 1931  
 
 1932  0
                 append( sb, "nocomment (Default: false)", 2 );
 1933  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 );
 1934  0
                 append( sb, "", 0 );
 1935  
 
 1936  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 1937  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1938  0
                 append( sb, "", 0 );
 1939  
 
 1940  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1941  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 );
 1942  0
                 append( sb, "", 0 );
 1943  
 
 1944  0
                 append( sb, "nohelp (Default: false)", 2 );
 1945  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 );
 1946  0
                 append( sb, "", 0 );
 1947  
 
 1948  0
                 append( sb, "noindex (Default: false)", 2 );
 1949  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1950  0
                 append( sb, "", 0 );
 1951  
 
 1952  0
                 append( sb, "nonavbar (Default: false)", 2 );
 1953  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1954  0
                 append( sb, "", 0 );
 1955  
 
 1956  0
                 append( sb, "nooverview (Default: false)", 2 );
 1957  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 );
 1958  0
                 append( sb, "", 0 );
 1959  
 
 1960  0
                 append( sb, "noqualifier", 2 );
 1961  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 );
 1962  0
                 append( sb, "", 0 );
 1963  
 
 1964  0
                 append( sb, "nosince (Default: false)", 2 );
 1965  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1966  0
                 append( sb, "", 0 );
 1967  
 
 1968  0
                 append( sb, "notimestamp (Default: false)", 2 );
 1969  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 );
 1970  0
                 append( sb, "", 0 );
 1971  
 
 1972  0
                 append( sb, "notree (Default: false)", 2 );
 1973  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1974  0
                 append( sb, "", 0 );
 1975  
 
 1976  0
                 append( sb, "offlineLinks", 2 );
 1977  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://java.sun.com/j2se/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 );
 1978  0
                 append( sb, "", 0 );
 1979  
 
 1980  0
                 append( sb, "old (Default: false)", 2 );
 1981  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1982  0
                 append( sb, "", 0 );
 1983  
 
 1984  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1985  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1986  0
                 append( sb, "", 0 );
 1987  
 
 1988  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1989  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 );
 1990  0
                 append( sb, "", 0 );
 1991  
 
 1992  0
                 append( sb, "packagesheader", 2 );
 1993  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1994  0
                 append( sb, "", 0 );
 1995  
 
 1996  0
                 append( sb, "proxyHost", 2 );
 1997  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1998  0
                 append( sb, "", 0 );
 1999  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 );
 2000  0
                 append( sb, "", 0 );
 2001  
 
 2002  0
                 append( sb, "proxyPort", 2 );
 2003  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2004  0
                 append( sb, "", 0 );
 2005  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 );
 2006  0
                 append( sb, "", 0 );
 2007  
 
 2008  0
                 append( sb, "quiet (Default: false)", 2 );
 2009  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 );
 2010  0
                 append( sb, "", 0 );
 2011  
 
 2012  0
                 append( sb, "remoteRepositories", 2 );
 2013  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2014  0
                 append( sb, "", 0 );
 2015  
 
 2016  0
                 append( sb, "resourcesArtifacts", 2 );
 2017  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 );
 2018  0
                 append( sb, "", 0 );
 2019  
 
 2020  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2021  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2022  0
                 append( sb, "", 0 );
 2023  
 
 2024  0
                 append( sb, "show (Default: protected)", 2 );
 2025  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 );
 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, "", 0 );
 2031  
 
 2032  0
                 append( sb, "source", 2 );
 2033  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 );
 2034  0
                 append( sb, "", 0 );
 2035  
 
 2036  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2037  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2038  0
                 append( sb, "", 0 );
 2039  
 
 2040  0
                 append( sb, "sourcepath", 2 );
 2041  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 );
 2042  0
                 append( sb, "", 0 );
 2043  
 
 2044  0
                 append( sb, "sourcetab", 2 );
 2045  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 );
 2046  0
                 append( sb, "", 0 );
 2047  
 
 2048  0
                 append( sb, "splitindex (Default: false)", 2 );
 2049  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 );
 2050  0
                 append( sb, "", 0 );
 2051  
 
 2052  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2053  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 );
 2054  0
                 append( sb, "", 0 );
 2055  
 
 2056  0
                 append( sb, "stylesheetfile", 2 );
 2057  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 );
 2058  0
                 append( sb, "", 0 );
 2059  
 
 2060  0
                 append( sb, "subpackages", 2 );
 2061  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 );
 2062  0
                 append( sb, "", 0 );
 2063  
 
 2064  0
                 append( sb, "taglet", 2 );
 2065  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 );
 2066  0
                 append( sb, "", 0 );
 2067  
 
 2068  0
                 append( sb, "tagletArtifact", 2 );
 2069  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 );
 2070  0
                 append( sb, "", 0 );
 2071  
 
 2072  0
                 append( sb, "tagletArtifacts", 2 );
 2073  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 );
 2074  0
                 append( sb, "", 0 );
 2075  
 
 2076  0
                 append( sb, "tagletpath", 2 );
 2077  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 );
 2078  0
                 append( sb, "", 0 );
 2079  
 
 2080  0
                 append( sb, "taglets", 2 );
 2081  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 );
 2082  0
                 append( sb, "", 0 );
 2083  
 
 2084  0
                 append( sb, "tags", 2 );
 2085  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 );
 2086  0
                 append( sb, "", 0 );
 2087  
 
 2088  0
                 append( sb, "top", 2 );
 2089  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2090  0
                 append( sb, "", 0 );
 2091  
 
 2092  0
                 append( sb, "use (Default: true)", 2 );
 2093  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2094  0
                 append( sb, "", 0 );
 2095  
 
 2096  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2097  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 );
 2098  0
                 append( sb, "", 0 );
 2099  
 
 2100  0
                 append( sb, "verbose (Default: false)", 2 );
 2101  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2102  0
                 append( sb, "", 0 );
 2103  
 
 2104  0
                 append( sb, "version (Default: true)", 2 );
 2105  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2106  0
                 append( sb, "", 0 );
 2107  
 
 2108  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2109  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2110  0
                 append( sb, "", 0 );
 2111  
             }
 2112  
         }
 2113  
 
 2114  0
         if ( goal == null || goal.length() <= 0 || "test-aggregate".equals( goal ) )
 2115  
         {
 2116  0
             append( sb, "javadoc:test-aggregate", 0 );
 2117  0
             append( sb, "Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.", 1 );
 2118  0
             append( sb, "", 0 );
 2119  0
             if ( detail )
 2120  
             {
 2121  0
                 append( sb, "Available parameters:", 1 );
 2122  0
                 append( sb, "", 0 );
 2123  
 
 2124  0
                 append( sb, "additionalJOption", 2 );
 2125  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 );
 2126  0
                 append( sb, "", 0 );
 2127  
 
 2128  0
                 append( sb, "additionalparam", 2 );
 2129  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 );
 2130  0
                 append( sb, "", 0 );
 2131  
 
 2132  0
                 append( sb, "aggregate (Default: false)", 2 );
 2133  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 2134  0
                 append( sb, "", 0 );
 2135  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 2136  0
                 append( sb, "", 0 );
 2137  
 
 2138  0
                 append( sb, "author (Default: true)", 2 );
 2139  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 2140  0
                 append( sb, "", 0 );
 2141  
 
 2142  0
                 append( sb, "bootclasspath", 2 );
 2143  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 );
 2144  0
                 append( sb, "", 0 );
 2145  
 
 2146  0
                 append( sb, "bootclasspathArtifacts", 2 );
 2147  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 );
 2148  0
                 append( sb, "", 0 );
 2149  
 
 2150  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 2151  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 );
 2152  0
                 append( sb, "", 0 );
 2153  
 
 2154  0
                 append( sb, "breakiterator (Default: false)", 2 );
 2155  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 2156  0
                 append( sb, "", 0 );
 2157  
 
 2158  0
                 append( sb, "charset", 2 );
 2159  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 );
 2160  0
                 append( sb, "", 0 );
 2161  
 
 2162  0
                 append( sb, "debug (Default: false)", 2 );
 2163  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 );
 2164  0
                 append( sb, "", 0 );
 2165  
 
 2166  0
                 append( sb, "dependencySourceExcludes", 2 );
 2167  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 2168  0
                 append( sb, "", 0 );
 2169  
 
 2170  0
                 append( sb, "dependencySourceIncludes", 2 );
 2171  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 2172  0
                 append( sb, "", 0 );
 2173  
 
 2174  0
                 append( sb, "description", 2 );
 2175  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 2176  0
                 append( sb, "", 0 );
 2177  
 
 2178  0
                 append( sb, "destDir (Default: testapidocs)", 2 );
 2179  0
                 append( sb, "The name of the destination directory.\n", 3 );
 2180  0
                 append( sb, "", 0 );
 2181  
 
 2182  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 2183  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 2184  0
                 append( sb, "", 0 );
 2185  
 
 2186  0
                 append( sb, "detectLinks (Default: false)", 2 );
 2187  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 );
 2188  0
                 append( sb, "", 0 );
 2189  
 
 2190  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 2191  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 );
 2192  0
                 append( sb, "", 0 );
 2193  
 
 2194  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 2195  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 2196  0
                 append( sb, "", 0 );
 2197  
 
 2198  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 2199  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 );
 2200  0
                 append( sb, "", 0 );
 2201  
 
 2202  0
                 append( sb, "doclet", 2 );
 2203  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 2204  0
                 append( sb, "", 0 );
 2205  
 
 2206  0
                 append( sb, "docletArtifact", 2 );
 2207  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 );
 2208  0
                 append( sb, "", 0 );
 2209  
 
 2210  0
                 append( sb, "docletArtifacts", 2 );
 2211  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 );
 2212  0
                 append( sb, "", 0 );
 2213  
 
 2214  0
                 append( sb, "docletPath", 2 );
 2215  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 );
 2216  0
                 append( sb, "", 0 );
 2217  
 
 2218  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 2219  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2220  0
                 append( sb, "", 0 );
 2221  
 
 2222  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2223  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 );
 2224  0
                 append( sb, "", 0 );
 2225  
 
 2226  0
                 append( sb, "excludedocfilessubdir", 2 );
 2227  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 );
 2228  0
                 append( sb, "", 0 );
 2229  
 
 2230  0
                 append( sb, "excludePackageNames", 2 );
 2231  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 );
 2232  0
                 append( sb, "", 0 );
 2233  
 
 2234  0
                 append( sb, "extdirs", 2 );
 2235  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 2236  0
                 append( sb, "", 0 );
 2237  
 
 2238  0
                 append( sb, "failOnError (Default: true)", 2 );
 2239  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 2240  0
                 append( sb, "", 0 );
 2241  
 
 2242  0
                 append( sb, "footer", 2 );
 2243  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 2244  0
                 append( sb, "", 0 );
 2245  
 
 2246  0
                 append( sb, "groups", 2 );
 2247  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 );
 2248  0
                 append( sb, "", 0 );
 2249  
 
 2250  0
                 append( sb, "header", 2 );
 2251  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 2252  0
                 append( sb, "", 0 );
 2253  
 
 2254  0
                 append( sb, "helpfile", 2 );
 2255  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 );
 2256  0
                 append( sb, "", 0 );
 2257  
 
 2258  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 2259  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 );
 2260  0
                 append( sb, "", 0 );
 2261  
 
 2262  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 2263  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 2264  0
                 append( sb, "", 0 );
 2265  
 
 2266  0
                 append( sb, "javaApiLinks", 2 );
 2267  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 );
 2268  0
                 append( sb, "", 0 );
 2269  
 
 2270  0
                 append( sb, "javadocDirectory", 2 );
 2271  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 );
 2272  0
                 append( sb, "", 0 );
 2273  
 
 2274  0
                 append( sb, "javadocExecutable", 2 );
 2275  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 );
 2276  0
                 append( sb, "", 0 );
 2277  
 
 2278  0
                 append( sb, "javadocVersion", 2 );
 2279  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 2280  0
                 append( sb, "", 0 );
 2281  
 
 2282  0
                 append( sb, "keywords (Default: false)", 2 );
 2283  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 );
 2284  0
                 append( sb, "", 0 );
 2285  
 
 2286  0
                 append( sb, "links", 2 );
 2287  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 2288  0
                 append( sb, "", 0 );
 2289  
 
 2290  0
                 append( sb, "linksource (Default: false)", 2 );
 2291  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 );
 2292  0
                 append( sb, "", 0 );
 2293  
 
 2294  0
                 append( sb, "locale", 2 );
 2295  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 2296  0
                 append( sb, "", 0 );
 2297  
 
 2298  0
                 append( sb, "localRepository", 2 );
 2299  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 2300  0
                 append( sb, "", 0 );
 2301  
 
 2302  0
                 append( sb, "maxmemory", 2 );
 2303  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 );
 2304  0
                 append( sb, "", 0 );
 2305  
 
 2306  0
                 append( sb, "minmemory", 2 );
 2307  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 );
 2308  0
                 append( sb, "", 0 );
 2309  
 
 2310  0
                 append( sb, "name", 2 );
 2311  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 2312  0
                 append( sb, "", 0 );
 2313  
 
 2314  0
                 append( sb, "nocomment (Default: false)", 2 );
 2315  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 );
 2316  0
                 append( sb, "", 0 );
 2317  
 
 2318  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 2319  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 2320  0
                 append( sb, "", 0 );
 2321  
 
 2322  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 2323  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 );
 2324  0
                 append( sb, "", 0 );
 2325  
 
 2326  0
                 append( sb, "nohelp (Default: false)", 2 );
 2327  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 );
 2328  0
                 append( sb, "", 0 );
 2329  
 
 2330  0
                 append( sb, "noindex (Default: false)", 2 );
 2331  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 2332  0
                 append( sb, "", 0 );
 2333  
 
 2334  0
                 append( sb, "nonavbar (Default: false)", 2 );
 2335  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 2336  0
                 append( sb, "", 0 );
 2337  
 
 2338  0
                 append( sb, "nooverview (Default: false)", 2 );
 2339  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 );
 2340  0
                 append( sb, "", 0 );
 2341  
 
 2342  0
                 append( sb, "noqualifier", 2 );
 2343  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 );
 2344  0
                 append( sb, "", 0 );
 2345  
 
 2346  0
                 append( sb, "nosince (Default: false)", 2 );
 2347  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 2348  0
                 append( sb, "", 0 );
 2349  
 
 2350  0
                 append( sb, "notimestamp (Default: false)", 2 );
 2351  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 );
 2352  0
                 append( sb, "", 0 );
 2353  
 
 2354  0
                 append( sb, "notree (Default: false)", 2 );
 2355  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 2356  0
                 append( sb, "", 0 );
 2357  
 
 2358  0
                 append( sb, "offlineLinks", 2 );
 2359  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://java.sun.com/j2se/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 );
 2360  0
                 append( sb, "", 0 );
 2361  
 
 2362  0
                 append( sb, "old (Default: false)", 2 );
 2363  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 2364  0
                 append( sb, "", 0 );
 2365  
 
 2366  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 2367  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 2368  0
                 append( sb, "", 0 );
 2369  
 
 2370  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 2371  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 );
 2372  0
                 append( sb, "", 0 );
 2373  
 
 2374  0
                 append( sb, "packagesheader", 2 );
 2375  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 2376  0
                 append( sb, "", 0 );
 2377  
 
 2378  0
                 append( sb, "proxyHost", 2 );
 2379  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 2380  0
                 append( sb, "", 0 );
 2381  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 );
 2382  0
                 append( sb, "", 0 );
 2383  
 
 2384  0
                 append( sb, "proxyPort", 2 );
 2385  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2386  0
                 append( sb, "", 0 );
 2387  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 );
 2388  0
                 append( sb, "", 0 );
 2389  
 
 2390  0
                 append( sb, "quiet (Default: false)", 2 );
 2391  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 );
 2392  0
                 append( sb, "", 0 );
 2393  
 
 2394  0
                 append( sb, "remoteRepositories", 2 );
 2395  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2396  0
                 append( sb, "", 0 );
 2397  
 
 2398  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
 2399  0
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 2400  0
                 append( sb, "", 0 );
 2401  
 
 2402  0
                 append( sb, "resourcesArtifacts", 2 );
 2403  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 );
 2404  0
                 append( sb, "", 0 );
 2405  
 
 2406  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2407  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2408  0
                 append( sb, "", 0 );
 2409  
 
 2410  0
                 append( sb, "show (Default: protected)", 2 );
 2411  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 );
 2412  0
                 append( sb, "", 0 );
 2413  
 
 2414  0
                 append( sb, "skip (Default: false)", 2 );
 2415  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2416  0
                 append( sb, "", 0 );
 2417  
 
 2418  0
                 append( sb, "source", 2 );
 2419  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 );
 2420  0
                 append( sb, "", 0 );
 2421  
 
 2422  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2423  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2424  0
                 append( sb, "", 0 );
 2425  
 
 2426  0
                 append( sb, "sourcepath", 2 );
 2427  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 );
 2428  0
                 append( sb, "", 0 );
 2429  
 
 2430  0
                 append( sb, "sourcetab", 2 );
 2431  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 );
 2432  0
                 append( sb, "", 0 );
 2433  
 
 2434  0
                 append( sb, "splitindex (Default: false)", 2 );
 2435  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 );
 2436  0
                 append( sb, "", 0 );
 2437  
 
 2438  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2439  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 );
 2440  0
                 append( sb, "", 0 );
 2441  
 
 2442  0
                 append( sb, "stylesheetfile", 2 );
 2443  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 );
 2444  0
                 append( sb, "", 0 );
 2445  
 
 2446  0
                 append( sb, "subpackages", 2 );
 2447  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 );
 2448  0
                 append( sb, "", 0 );
 2449  
 
 2450  0
                 append( sb, "taglet", 2 );
 2451  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 );
 2452  0
                 append( sb, "", 0 );
 2453  
 
 2454  0
                 append( sb, "tagletArtifact", 2 );
 2455  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 );
 2456  0
                 append( sb, "", 0 );
 2457  
 
 2458  0
                 append( sb, "tagletArtifacts", 2 );
 2459  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 );
 2460  0
                 append( sb, "", 0 );
 2461  
 
 2462  0
                 append( sb, "tagletpath", 2 );
 2463  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 );
 2464  0
                 append( sb, "", 0 );
 2465  
 
 2466  0
                 append( sb, "taglets", 2 );
 2467  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 );
 2468  0
                 append( sb, "", 0 );
 2469  
 
 2470  0
                 append( sb, "tags", 2 );
 2471  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 );
 2472  0
                 append( sb, "", 0 );
 2473  
 
 2474  0
                 append( sb, "testDescription", 2 );
 2475  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 );
 2476  0
                 append( sb, "", 0 );
 2477  
 
 2478  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2479  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2480  0
                 append( sb, "", 0 );
 2481  
 
 2482  0
                 append( sb, "testJavadocDirectory", 2 );
 2483  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 );
 2484  0
                 append( sb, "", 0 );
 2485  
 
 2486  0
                 append( sb, "testName", 2 );
 2487  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 );
 2488  0
                 append( sb, "", 0 );
 2489  
 
 2490  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 2491  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 );
 2492  0
                 append( sb, "", 0 );
 2493  
 
 2494  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2495  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2496  0
                 append( sb, "", 0 );
 2497  
 
 2498  0
                 append( sb, "top", 2 );
 2499  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2500  0
                 append( sb, "", 0 );
 2501  
 
 2502  0
                 append( sb, "use (Default: true)", 2 );
 2503  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2504  0
                 append( sb, "", 0 );
 2505  
 
 2506  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2507  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 );
 2508  0
                 append( sb, "", 0 );
 2509  
 
 2510  0
                 append( sb, "verbose (Default: false)", 2 );
 2511  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2512  0
                 append( sb, "", 0 );
 2513  
 
 2514  0
                 append( sb, "version (Default: true)", 2 );
 2515  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2516  0
                 append( sb, "", 0 );
 2517  
 
 2518  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2519  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2520  0
                 append( sb, "", 0 );
 2521  
             }
 2522  
         }
 2523  
 
 2524  0
         if ( goal == null || goal.length() <= 0 || "test-aggregate-jar".equals( goal ) )
 2525  
         {
 2526  0
             append( sb, "javadoc:test-aggregate-jar", 0 );
 2527  0
             append( sb, "Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
 2528  0
             append( sb, "", 0 );
 2529  0
             if ( detail )
 2530  
             {
 2531  0
                 append( sb, "Available parameters:", 1 );
 2532  0
                 append( sb, "", 0 );
 2533  
 
 2534  0
                 append( sb, "additionalJOption", 2 );
 2535  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 );
 2536  0
                 append( sb, "", 0 );
 2537  
 
 2538  0
                 append( sb, "additionalparam", 2 );
 2539  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 );
 2540  0
                 append( sb, "", 0 );
 2541  
 
 2542  0
                 append( sb, "aggregate (Default: false)", 2 );
 2543  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 2544  0
                 append( sb, "", 0 );
 2545  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 2546  0
                 append( sb, "", 0 );
 2547  
 
 2548  0
                 append( sb, "archive", 2 );
 2549  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 2550  0
                 append( sb, "", 0 );
 2551  
 
 2552  0
                 append( sb, "attach (Default: true)", 2 );
 2553  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 2554  0
                 append( sb, "", 0 );
 2555  
 
 2556  0
                 append( sb, "author (Default: true)", 2 );
 2557  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 2558  0
                 append( sb, "", 0 );
 2559  
 
 2560  0
                 append( sb, "bootclasspath", 2 );
 2561  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 );
 2562  0
                 append( sb, "", 0 );
 2563  
 
 2564  0
                 append( sb, "bootclasspathArtifacts", 2 );
 2565  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 );
 2566  0
                 append( sb, "", 0 );
 2567  
 
 2568  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 2569  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 );
 2570  0
                 append( sb, "", 0 );
 2571  
 
 2572  0
                 append( sb, "breakiterator (Default: false)", 2 );
 2573  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 2574  0
                 append( sb, "", 0 );
 2575  
 
 2576  0
                 append( sb, "charset", 2 );
 2577  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 );
 2578  0
                 append( sb, "", 0 );
 2579  
 
 2580  0
                 append( sb, "debug (Default: false)", 2 );
 2581  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 );
 2582  0
                 append( sb, "", 0 );
 2583  
 
 2584  0
                 append( sb, "dependencySourceExcludes", 2 );
 2585  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 2586  0
                 append( sb, "", 0 );
 2587  
 
 2588  0
                 append( sb, "dependencySourceIncludes", 2 );
 2589  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 2590  0
                 append( sb, "", 0 );
 2591  
 
 2592  0
                 append( sb, "destDir", 2 );
 2593  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 2594  0
                 append( sb, "", 0 );
 2595  
 
 2596  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 2597  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 2598  0
                 append( sb, "", 0 );
 2599  
 
 2600  0
                 append( sb, "detectLinks (Default: false)", 2 );
 2601  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 );
 2602  0
                 append( sb, "", 0 );
 2603  
 
 2604  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 2605  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 );
 2606  0
                 append( sb, "", 0 );
 2607  
 
 2608  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 2609  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 2610  0
                 append( sb, "", 0 );
 2611  
 
 2612  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 2613  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 );
 2614  0
                 append( sb, "", 0 );
 2615  
 
 2616  0
                 append( sb, "doclet", 2 );
 2617  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 2618  0
                 append( sb, "", 0 );
 2619  
 
 2620  0
                 append( sb, "docletArtifact", 2 );
 2621  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 );
 2622  0
                 append( sb, "", 0 );
 2623  
 
 2624  0
                 append( sb, "docletArtifacts", 2 );
 2625  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 );
 2626  0
                 append( sb, "", 0 );
 2627  
 
 2628  0
                 append( sb, "docletPath", 2 );
 2629  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 );
 2630  0
                 append( sb, "", 0 );
 2631  
 
 2632  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 2633  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2634  0
                 append( sb, "", 0 );
 2635  
 
 2636  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2637  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 );
 2638  0
                 append( sb, "", 0 );
 2639  
 
 2640  0
                 append( sb, "excludedocfilessubdir", 2 );
 2641  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 );
 2642  0
                 append( sb, "", 0 );
 2643  
 
 2644  0
                 append( sb, "excludePackageNames", 2 );
 2645  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 );
 2646  0
                 append( sb, "", 0 );
 2647  
 
 2648  0
                 append( sb, "extdirs", 2 );
 2649  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 2650  0
                 append( sb, "", 0 );
 2651  
 
 2652  0
                 append( sb, "failOnError (Default: true)", 2 );
 2653  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 2654  0
                 append( sb, "", 0 );
 2655  
 
 2656  0
                 append( sb, "finalName", 2 );
 2657  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 );
 2658  0
                 append( sb, "", 0 );
 2659  
 
 2660  0
                 append( sb, "footer", 2 );
 2661  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 2662  0
                 append( sb, "", 0 );
 2663  
 
 2664  0
                 append( sb, "groups", 2 );
 2665  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 );
 2666  0
                 append( sb, "", 0 );
 2667  
 
 2668  0
                 append( sb, "header", 2 );
 2669  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 2670  0
                 append( sb, "", 0 );
 2671  
 
 2672  0
                 append( sb, "helpfile", 2 );
 2673  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 );
 2674  0
                 append( sb, "", 0 );
 2675  
 
 2676  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 2677  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 );
 2678  0
                 append( sb, "", 0 );
 2679  
 
 2680  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 2681  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 2682  0
                 append( sb, "", 0 );
 2683  
 
 2684  0
                 append( sb, "jarOutputDirectory", 2 );
 2685  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 2686  0
                 append( sb, "", 0 );
 2687  
 
 2688  0
                 append( sb, "javaApiLinks", 2 );
 2689  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 );
 2690  0
                 append( sb, "", 0 );
 2691  
 
 2692  0
                 append( sb, "javadocDirectory", 2 );
 2693  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 );
 2694  0
                 append( sb, "", 0 );
 2695  
 
 2696  0
                 append( sb, "javadocExecutable", 2 );
 2697  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 );
 2698  0
                 append( sb, "", 0 );
 2699  
 
 2700  0
                 append( sb, "javadocVersion", 2 );
 2701  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 2702  0
                 append( sb, "", 0 );
 2703  
 
 2704  0
                 append( sb, "keywords (Default: false)", 2 );
 2705  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 );
 2706  0
                 append( sb, "", 0 );
 2707  
 
 2708  0
                 append( sb, "links", 2 );
 2709  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 2710  0
                 append( sb, "", 0 );
 2711  
 
 2712  0
                 append( sb, "linksource (Default: false)", 2 );
 2713  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 );
 2714  0
                 append( sb, "", 0 );
 2715  
 
 2716  0
                 append( sb, "locale", 2 );
 2717  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 2718  0
                 append( sb, "", 0 );
 2719  
 
 2720  0
                 append( sb, "localRepository", 2 );
 2721  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 2722  0
                 append( sb, "", 0 );
 2723  
 
 2724  0
                 append( sb, "maxmemory", 2 );
 2725  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 );
 2726  0
                 append( sb, "", 0 );
 2727  
 
 2728  0
                 append( sb, "minmemory", 2 );
 2729  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 );
 2730  0
                 append( sb, "", 0 );
 2731  
 
 2732  0
                 append( sb, "nocomment (Default: false)", 2 );
 2733  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 );
 2734  0
                 append( sb, "", 0 );
 2735  
 
 2736  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 2737  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 2738  0
                 append( sb, "", 0 );
 2739  
 
 2740  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 2741  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 );
 2742  0
                 append( sb, "", 0 );
 2743  
 
 2744  0
                 append( sb, "nohelp (Default: false)", 2 );
 2745  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 );
 2746  0
                 append( sb, "", 0 );
 2747  
 
 2748  0
                 append( sb, "noindex (Default: false)", 2 );
 2749  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 2750  0
                 append( sb, "", 0 );
 2751  
 
 2752  0
                 append( sb, "nonavbar (Default: false)", 2 );
 2753  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 2754  0
                 append( sb, "", 0 );
 2755  
 
 2756  0
                 append( sb, "nooverview (Default: false)", 2 );
 2757  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 );
 2758  0
                 append( sb, "", 0 );
 2759  
 
 2760  0
                 append( sb, "noqualifier", 2 );
 2761  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 );
 2762  0
                 append( sb, "", 0 );
 2763  
 
 2764  0
                 append( sb, "nosince (Default: false)", 2 );
 2765  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 2766  0
                 append( sb, "", 0 );
 2767  
 
 2768  0
                 append( sb, "notimestamp (Default: false)", 2 );
 2769  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 );
 2770  0
                 append( sb, "", 0 );
 2771  
 
 2772  0
                 append( sb, "notree (Default: false)", 2 );
 2773  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 2774  0
                 append( sb, "", 0 );
 2775  
 
 2776  0
                 append( sb, "offlineLinks", 2 );
 2777  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://java.sun.com/j2se/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 );
 2778  0
                 append( sb, "", 0 );
 2779  
 
 2780  0
                 append( sb, "old (Default: false)", 2 );
 2781  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 2782  0
                 append( sb, "", 0 );
 2783  
 
 2784  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
 2785  0
                 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
 2786  0
                 append( sb, "", 0 );
 2787  
 
 2788  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 2789  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 );
 2790  0
                 append( sb, "", 0 );
 2791  
 
 2792  0
                 append( sb, "packagesheader", 2 );
 2793  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 2794  0
                 append( sb, "", 0 );
 2795  
 
 2796  0
                 append( sb, "proxyHost", 2 );
 2797  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 2798  0
                 append( sb, "", 0 );
 2799  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 );
 2800  0
                 append( sb, "", 0 );
 2801  
 
 2802  0
                 append( sb, "proxyPort", 2 );
 2803  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2804  0
                 append( sb, "", 0 );
 2805  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 );
 2806  0
                 append( sb, "", 0 );
 2807  
 
 2808  0
                 append( sb, "quiet (Default: false)", 2 );
 2809  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 );
 2810  0
                 append( sb, "", 0 );
 2811  
 
 2812  0
                 append( sb, "remoteRepositories", 2 );
 2813  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2814  0
                 append( sb, "", 0 );
 2815  
 
 2816  0
                 append( sb, "resourcesArtifacts", 2 );
 2817  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 );
 2818  0
                 append( sb, "", 0 );
 2819  
 
 2820  0
                 append( sb, "serialwarn (Default: false)", 2 );
 2821  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2822  0
                 append( sb, "", 0 );
 2823  
 
 2824  0
                 append( sb, "show (Default: protected)", 2 );
 2825  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 );
 2826  0
                 append( sb, "", 0 );
 2827  
 
 2828  0
                 append( sb, "skip (Default: false)", 2 );
 2829  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2830  0
                 append( sb, "", 0 );
 2831  
 
 2832  0
                 append( sb, "source", 2 );
 2833  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 );
 2834  0
                 append( sb, "", 0 );
 2835  
 
 2836  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 2837  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 2838  0
                 append( sb, "", 0 );
 2839  
 
 2840  0
                 append( sb, "sourcepath", 2 );
 2841  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 );
 2842  0
                 append( sb, "", 0 );
 2843  
 
 2844  0
                 append( sb, "sourcetab", 2 );
 2845  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 );
 2846  0
                 append( sb, "", 0 );
 2847  
 
 2848  0
                 append( sb, "splitindex (Default: false)", 2 );
 2849  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 );
 2850  0
                 append( sb, "", 0 );
 2851  
 
 2852  0
                 append( sb, "stylesheet (Default: java)", 2 );
 2853  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 );
 2854  0
                 append( sb, "", 0 );
 2855  
 
 2856  0
                 append( sb, "stylesheetfile", 2 );
 2857  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 );
 2858  0
                 append( sb, "", 0 );
 2859  
 
 2860  0
                 append( sb, "subpackages", 2 );
 2861  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 );
 2862  0
                 append( sb, "", 0 );
 2863  
 
 2864  0
                 append( sb, "taglet", 2 );
 2865  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 );
 2866  0
                 append( sb, "", 0 );
 2867  
 
 2868  0
                 append( sb, "tagletArtifact", 2 );
 2869  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 );
 2870  0
                 append( sb, "", 0 );
 2871  
 
 2872  0
                 append( sb, "tagletArtifacts", 2 );
 2873  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 );
 2874  0
                 append( sb, "", 0 );
 2875  
 
 2876  0
                 append( sb, "tagletpath", 2 );
 2877  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 );
 2878  0
                 append( sb, "", 0 );
 2879  
 
 2880  0
                 append( sb, "taglets", 2 );
 2881  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 );
 2882  0
                 append( sb, "", 0 );
 2883  
 
 2884  0
                 append( sb, "tags", 2 );
 2885  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 );
 2886  0
                 append( sb, "", 0 );
 2887  
 
 2888  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2889  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2890  0
                 append( sb, "", 0 );
 2891  
 
 2892  0
                 append( sb, "testJavadocDirectory", 2 );
 2893  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 2894  0
                 append( sb, "", 0 );
 2895  
 
 2896  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 2897  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 );
 2898  0
                 append( sb, "", 0 );
 2899  
 
 2900  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2901  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2902  0
                 append( sb, "", 0 );
 2903  
 
 2904  0
                 append( sb, "top", 2 );
 2905  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2906  0
                 append( sb, "", 0 );
 2907  
 
 2908  0
                 append( sb, "use (Default: true)", 2 );
 2909  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2910  0
                 append( sb, "", 0 );
 2911  
 
 2912  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 2913  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 2914  0
                 append( sb, "", 0 );
 2915  
 
 2916  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2917  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 );
 2918  0
                 append( sb, "", 0 );
 2919  
 
 2920  0
                 append( sb, "verbose (Default: false)", 2 );
 2921  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2922  0
                 append( sb, "", 0 );
 2923  
 
 2924  0
                 append( sb, "version (Default: true)", 2 );
 2925  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2926  0
                 append( sb, "", 0 );
 2927  
 
 2928  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2929  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2930  0
                 append( sb, "", 0 );
 2931  
             }
 2932  
         }
 2933  
 
 2934  0
         if ( goal == null || goal.length() <= 0 || "test-fix".equals( goal ) )
 2935  
         {
 2936  0
             append( sb, "javadoc:test-fix", 0 );
 2937  0
             append( sb, "Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.", 1 );
 2938  0
             append( sb, "", 0 );
 2939  0
             if ( detail )
 2940  
             {
 2941  0
                 append( sb, "Available parameters:", 1 );
 2942  0
                 append( sb, "", 0 );
 2943  
 
 2944  0
                 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
 2945  0
                 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
 2946  0
                 append( sb, "", 0 );
 2947  
 
 2948  0
                 append( sb, "defaultAuthor", 2 );
 2949  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 );
 2950  0
                 append( sb, "", 0 );
 2951  
 
 2952  0
                 append( sb, "defaultSince (Default: ${project.version})", 2 );
 2953  0
                 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
 2954  0
                 append( sb, "", 0 );
 2955  
 
 2956  0
                 append( sb, "defaultVersion", 2 );
 2957  0
                 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id: org.apache.maven.plugin.javadoc.HelpMojo.html 829396 2012-08-19 17:35:19Z hboutemy $, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
 2958  0
                 append( sb, "", 0 );
 2959  
 
 2960  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2961  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 );
 2962  0
                 append( sb, "", 0 );
 2963  
 
 2964  0
                 append( sb, "excludes", 2 );
 2965  0
                 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
 2966  0
                 append( sb, "", 0 );
 2967  
 
 2968  0
                 append( sb, "fixClassComment (Default: true)", 2 );
 2969  0
                 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
 2970  0
                 append( sb, "", 0 );
 2971  
 
 2972  0
                 append( sb, "fixFieldComment (Default: true)", 2 );
 2973  0
                 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
 2974  0
                 append( sb, "", 0 );
 2975  
 
 2976  0
                 append( sb, "fixMethodComment (Default: true)", 2 );
 2977  0
                 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
 2978  0
                 append( sb, "", 0 );
 2979  
 
 2980  0
                 append( sb, "fixTags (Default: all)", 2 );
 2981  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 );
 2982  0
                 append( sb, "", 0 );
 2983  
 
 2984  0
                 append( sb, "force", 2 );
 2985  0
                 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
 2986  0
                 append( sb, "", 0 );
 2987  
 
 2988  0
                 append( sb, "ignoreClirr (Default: false)", 2 );
 2989  0
                 append( sb, "Flag to ignore or not Clirr.", 3 );
 2990  0
                 append( sb, "", 0 );
 2991  
 
 2992  0
                 append( sb, "includes (Default: **/*.java)", 2 );
 2993  0
                 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
 2994  0
                 append( sb, "", 0 );
 2995  
 
 2996  0
                 append( sb, "level (Default: protected)", 2 );
 2997  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 );
 2998  0
                 append( sb, "", 0 );
 2999  
 
 3000  0
                 append( sb, "localRepository", 2 );
 3001  0
                 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
 3002  0
                 append( sb, "", 0 );
 3003  
 
 3004  0
                 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
 3005  0
                 append( sb, "Output directory where Java classes will be rewrited.", 3 );
 3006  0
                 append( sb, "", 0 );
 3007  
             }
 3008  
         }
 3009  
 
 3010  0
         if ( goal == null || goal.length() <= 0 || "test-jar".equals( goal ) )
 3011  
         {
 3012  0
             append( sb, "javadoc:test-jar", 0 );
 3013  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 );
 3014  0
             append( sb, "", 0 );
 3015  0
             if ( detail )
 3016  
             {
 3017  0
                 append( sb, "Available parameters:", 1 );
 3018  0
                 append( sb, "", 0 );
 3019  
 
 3020  0
                 append( sb, "additionalJOption", 2 );
 3021  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 );
 3022  0
                 append( sb, "", 0 );
 3023  
 
 3024  0
                 append( sb, "additionalparam", 2 );
 3025  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 );
 3026  0
                 append( sb, "", 0 );
 3027  
 
 3028  0
                 append( sb, "aggregate (Default: false)", 2 );
 3029  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 3030  0
                 append( sb, "", 0 );
 3031  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 3032  0
                 append( sb, "", 0 );
 3033  
 
 3034  0
                 append( sb, "archive", 2 );
 3035  0
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 3036  0
                 append( sb, "", 0 );
 3037  
 
 3038  0
                 append( sb, "attach (Default: true)", 2 );
 3039  0
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 3040  0
                 append( sb, "", 0 );
 3041  
 
 3042  0
                 append( sb, "author (Default: true)", 2 );
 3043  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 3044  0
                 append( sb, "", 0 );
 3045  
 
 3046  0
                 append( sb, "bootclasspath", 2 );
 3047  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 );
 3048  0
                 append( sb, "", 0 );
 3049  
 
 3050  0
                 append( sb, "bootclasspathArtifacts", 2 );
 3051  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 );
 3052  0
                 append( sb, "", 0 );
 3053  
 
 3054  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 3055  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 );
 3056  0
                 append( sb, "", 0 );
 3057  
 
 3058  0
                 append( sb, "breakiterator (Default: false)", 2 );
 3059  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 3060  0
                 append( sb, "", 0 );
 3061  
 
 3062  0
                 append( sb, "charset", 2 );
 3063  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 );
 3064  0
                 append( sb, "", 0 );
 3065  
 
 3066  0
                 append( sb, "debug (Default: false)", 2 );
 3067  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 );
 3068  0
                 append( sb, "", 0 );
 3069  
 
 3070  0
                 append( sb, "dependencySourceExcludes", 2 );
 3071  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 3072  0
                 append( sb, "", 0 );
 3073  
 
 3074  0
                 append( sb, "dependencySourceIncludes", 2 );
 3075  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 3076  0
                 append( sb, "", 0 );
 3077  
 
 3078  0
                 append( sb, "destDir", 2 );
 3079  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 3080  0
                 append( sb, "", 0 );
 3081  
 
 3082  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 3083  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 3084  0
                 append( sb, "", 0 );
 3085  
 
 3086  0
                 append( sb, "detectLinks (Default: false)", 2 );
 3087  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 );
 3088  0
                 append( sb, "", 0 );
 3089  
 
 3090  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 3091  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 );
 3092  0
                 append( sb, "", 0 );
 3093  
 
 3094  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 3095  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 3096  0
                 append( sb, "", 0 );
 3097  
 
 3098  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 3099  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 );
 3100  0
                 append( sb, "", 0 );
 3101  
 
 3102  0
                 append( sb, "doclet", 2 );
 3103  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 3104  0
                 append( sb, "", 0 );
 3105  
 
 3106  0
                 append( sb, "docletArtifact", 2 );
 3107  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 );
 3108  0
                 append( sb, "", 0 );
 3109  
 
 3110  0
                 append( sb, "docletArtifacts", 2 );
 3111  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 );
 3112  0
                 append( sb, "", 0 );
 3113  
 
 3114  0
                 append( sb, "docletPath", 2 );
 3115  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 );
 3116  0
                 append( sb, "", 0 );
 3117  
 
 3118  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 3119  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3120  0
                 append( sb, "", 0 );
 3121  
 
 3122  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3123  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 );
 3124  0
                 append( sb, "", 0 );
 3125  
 
 3126  0
                 append( sb, "excludedocfilessubdir", 2 );
 3127  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 );
 3128  0
                 append( sb, "", 0 );
 3129  
 
 3130  0
                 append( sb, "excludePackageNames", 2 );
 3131  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 );
 3132  0
                 append( sb, "", 0 );
 3133  
 
 3134  0
                 append( sb, "extdirs", 2 );
 3135  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 3136  0
                 append( sb, "", 0 );
 3137  
 
 3138  0
                 append( sb, "failOnError (Default: true)", 2 );
 3139  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 3140  0
                 append( sb, "", 0 );
 3141  
 
 3142  0
                 append( sb, "finalName", 2 );
 3143  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 );
 3144  0
                 append( sb, "", 0 );
 3145  
 
 3146  0
                 append( sb, "footer", 2 );
 3147  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 3148  0
                 append( sb, "", 0 );
 3149  
 
 3150  0
                 append( sb, "groups", 2 );
 3151  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 );
 3152  0
                 append( sb, "", 0 );
 3153  
 
 3154  0
                 append( sb, "header", 2 );
 3155  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 3156  0
                 append( sb, "", 0 );
 3157  
 
 3158  0
                 append( sb, "helpfile", 2 );
 3159  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 );
 3160  0
                 append( sb, "", 0 );
 3161  
 
 3162  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 3163  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 );
 3164  0
                 append( sb, "", 0 );
 3165  
 
 3166  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 3167  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 3168  0
                 append( sb, "", 0 );
 3169  
 
 3170  0
                 append( sb, "jarOutputDirectory", 2 );
 3171  0
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 3172  0
                 append( sb, "", 0 );
 3173  
 
 3174  0
                 append( sb, "javaApiLinks", 2 );
 3175  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 );
 3176  0
                 append( sb, "", 0 );
 3177  
 
 3178  0
                 append( sb, "javadocDirectory", 2 );
 3179  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 );
 3180  0
                 append( sb, "", 0 );
 3181  
 
 3182  0
                 append( sb, "javadocExecutable", 2 );
 3183  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 );
 3184  0
                 append( sb, "", 0 );
 3185  
 
 3186  0
                 append( sb, "javadocVersion", 2 );
 3187  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 3188  0
                 append( sb, "", 0 );
 3189  
 
 3190  0
                 append( sb, "keywords (Default: false)", 2 );
 3191  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 );
 3192  0
                 append( sb, "", 0 );
 3193  
 
 3194  0
                 append( sb, "links", 2 );
 3195  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 3196  0
                 append( sb, "", 0 );
 3197  
 
 3198  0
                 append( sb, "linksource (Default: false)", 2 );
 3199  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 );
 3200  0
                 append( sb, "", 0 );
 3201  
 
 3202  0
                 append( sb, "locale", 2 );
 3203  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 3204  0
                 append( sb, "", 0 );
 3205  
 
 3206  0
                 append( sb, "localRepository", 2 );
 3207  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 3208  0
                 append( sb, "", 0 );
 3209  
 
 3210  0
                 append( sb, "maxmemory", 2 );
 3211  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 );
 3212  0
                 append( sb, "", 0 );
 3213  
 
 3214  0
                 append( sb, "minmemory", 2 );
 3215  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 );
 3216  0
                 append( sb, "", 0 );
 3217  
 
 3218  0
                 append( sb, "nocomment (Default: false)", 2 );
 3219  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 );
 3220  0
                 append( sb, "", 0 );
 3221  
 
 3222  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 3223  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 3224  0
                 append( sb, "", 0 );
 3225  
 
 3226  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 3227  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 );
 3228  0
                 append( sb, "", 0 );
 3229  
 
 3230  0
                 append( sb, "nohelp (Default: false)", 2 );
 3231  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 );
 3232  0
                 append( sb, "", 0 );
 3233  
 
 3234  0
                 append( sb, "noindex (Default: false)", 2 );
 3235  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 3236  0
                 append( sb, "", 0 );
 3237  
 
 3238  0
                 append( sb, "nonavbar (Default: false)", 2 );
 3239  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 3240  0
                 append( sb, "", 0 );
 3241  
 
 3242  0
                 append( sb, "nooverview (Default: false)", 2 );
 3243  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 );
 3244  0
                 append( sb, "", 0 );
 3245  
 
 3246  0
                 append( sb, "noqualifier", 2 );
 3247  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 );
 3248  0
                 append( sb, "", 0 );
 3249  
 
 3250  0
                 append( sb, "nosince (Default: false)", 2 );
 3251  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 3252  0
                 append( sb, "", 0 );
 3253  
 
 3254  0
                 append( sb, "notimestamp (Default: false)", 2 );
 3255  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 );
 3256  0
                 append( sb, "", 0 );
 3257  
 
 3258  0
                 append( sb, "notree (Default: false)", 2 );
 3259  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 3260  0
                 append( sb, "", 0 );
 3261  
 
 3262  0
                 append( sb, "offlineLinks", 2 );
 3263  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://java.sun.com/j2se/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 );
 3264  0
                 append( sb, "", 0 );
 3265  
 
 3266  0
                 append( sb, "old (Default: false)", 2 );
 3267  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 3268  0
                 append( sb, "", 0 );
 3269  
 
 3270  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
 3271  0
                 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
 3272  0
                 append( sb, "", 0 );
 3273  
 
 3274  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 3275  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 );
 3276  0
                 append( sb, "", 0 );
 3277  
 
 3278  0
                 append( sb, "packagesheader", 2 );
 3279  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 3280  0
                 append( sb, "", 0 );
 3281  
 
 3282  0
                 append( sb, "proxyHost", 2 );
 3283  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 3284  0
                 append( sb, "", 0 );
 3285  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 );
 3286  0
                 append( sb, "", 0 );
 3287  
 
 3288  0
                 append( sb, "proxyPort", 2 );
 3289  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 3290  0
                 append( sb, "", 0 );
 3291  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 );
 3292  0
                 append( sb, "", 0 );
 3293  
 
 3294  0
                 append( sb, "quiet (Default: false)", 2 );
 3295  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 );
 3296  0
                 append( sb, "", 0 );
 3297  
 
 3298  0
                 append( sb, "remoteRepositories", 2 );
 3299  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 3300  0
                 append( sb, "", 0 );
 3301  
 
 3302  0
                 append( sb, "resourcesArtifacts", 2 );
 3303  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 );
 3304  0
                 append( sb, "", 0 );
 3305  
 
 3306  0
                 append( sb, "serialwarn (Default: false)", 2 );
 3307  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 3308  0
                 append( sb, "", 0 );
 3309  
 
 3310  0
                 append( sb, "show (Default: protected)", 2 );
 3311  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 );
 3312  0
                 append( sb, "", 0 );
 3313  
 
 3314  0
                 append( sb, "skip (Default: false)", 2 );
 3315  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 3316  0
                 append( sb, "", 0 );
 3317  
 
 3318  0
                 append( sb, "source", 2 );
 3319  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 );
 3320  0
                 append( sb, "", 0 );
 3321  
 
 3322  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 3323  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 3324  0
                 append( sb, "", 0 );
 3325  
 
 3326  0
                 append( sb, "sourcepath", 2 );
 3327  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 );
 3328  0
                 append( sb, "", 0 );
 3329  
 
 3330  0
                 append( sb, "sourcetab", 2 );
 3331  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 );
 3332  0
                 append( sb, "", 0 );
 3333  
 
 3334  0
                 append( sb, "splitindex (Default: false)", 2 );
 3335  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 );
 3336  0
                 append( sb, "", 0 );
 3337  
 
 3338  0
                 append( sb, "stylesheet (Default: java)", 2 );
 3339  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 );
 3340  0
                 append( sb, "", 0 );
 3341  
 
 3342  0
                 append( sb, "stylesheetfile", 2 );
 3343  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 );
 3344  0
                 append( sb, "", 0 );
 3345  
 
 3346  0
                 append( sb, "subpackages", 2 );
 3347  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 );
 3348  0
                 append( sb, "", 0 );
 3349  
 
 3350  0
                 append( sb, "taglet", 2 );
 3351  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 );
 3352  0
                 append( sb, "", 0 );
 3353  
 
 3354  0
                 append( sb, "tagletArtifact", 2 );
 3355  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 );
 3356  0
                 append( sb, "", 0 );
 3357  
 
 3358  0
                 append( sb, "tagletArtifacts", 2 );
 3359  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 );
 3360  0
                 append( sb, "", 0 );
 3361  
 
 3362  0
                 append( sb, "tagletpath", 2 );
 3363  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 );
 3364  0
                 append( sb, "", 0 );
 3365  
 
 3366  0
                 append( sb, "taglets", 2 );
 3367  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 );
 3368  0
                 append( sb, "", 0 );
 3369  
 
 3370  0
                 append( sb, "tags", 2 );
 3371  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 );
 3372  0
                 append( sb, "", 0 );
 3373  
 
 3374  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3375  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3376  0
                 append( sb, "", 0 );
 3377  
 
 3378  0
                 append( sb, "testJavadocDirectory", 2 );
 3379  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 3380  0
                 append( sb, "", 0 );
 3381  
 
 3382  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 3383  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 );
 3384  0
                 append( sb, "", 0 );
 3385  
 
 3386  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3387  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3388  0
                 append( sb, "", 0 );
 3389  
 
 3390  0
                 append( sb, "top", 2 );
 3391  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 3392  0
                 append( sb, "", 0 );
 3393  
 
 3394  0
                 append( sb, "use (Default: true)", 2 );
 3395  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 3396  0
                 append( sb, "", 0 );
 3397  
 
 3398  0
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 3399  0
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 3400  0
                 append( sb, "", 0 );
 3401  
 
 3402  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 3403  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 );
 3404  0
                 append( sb, "", 0 );
 3405  
 
 3406  0
                 append( sb, "verbose (Default: false)", 2 );
 3407  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 3408  0
                 append( sb, "", 0 );
 3409  
 
 3410  0
                 append( sb, "version (Default: true)", 2 );
 3411  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 3412  0
                 append( sb, "", 0 );
 3413  
 
 3414  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 3415  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3416  0
                 append( sb, "", 0 );
 3417  
             }
 3418  
         }
 3419  
 
 3420  0
         if ( goal == null || goal.length() <= 0 || "test-javadoc".equals( goal ) )
 3421  
         {
 3422  0
             append( sb, "javadoc:test-javadoc", 0 );
 3423  0
             append( sb, "Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.", 1 );
 3424  0
             append( sb, "", 0 );
 3425  0
             if ( detail )
 3426  
             {
 3427  0
                 append( sb, "Available parameters:", 1 );
 3428  0
                 append( sb, "", 0 );
 3429  
 
 3430  0
                 append( sb, "additionalJOption", 2 );
 3431  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 );
 3432  0
                 append( sb, "", 0 );
 3433  
 
 3434  0
                 append( sb, "additionalparam", 2 );
 3435  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 );
 3436  0
                 append( sb, "", 0 );
 3437  
 
 3438  0
                 append( sb, "aggregate (Default: false)", 2 );
 3439  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 3440  0
                 append( sb, "", 0 );
 3441  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 3442  0
                 append( sb, "", 0 );
 3443  
 
 3444  0
                 append( sb, "author (Default: true)", 2 );
 3445  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 3446  0
                 append( sb, "", 0 );
 3447  
 
 3448  0
                 append( sb, "bootclasspath", 2 );
 3449  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 );
 3450  0
                 append( sb, "", 0 );
 3451  
 
 3452  0
                 append( sb, "bootclasspathArtifacts", 2 );
 3453  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 );
 3454  0
                 append( sb, "", 0 );
 3455  
 
 3456  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 3457  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 );
 3458  0
                 append( sb, "", 0 );
 3459  
 
 3460  0
                 append( sb, "breakiterator (Default: false)", 2 );
 3461  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 3462  0
                 append( sb, "", 0 );
 3463  
 
 3464  0
                 append( sb, "charset", 2 );
 3465  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 );
 3466  0
                 append( sb, "", 0 );
 3467  
 
 3468  0
                 append( sb, "debug (Default: false)", 2 );
 3469  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 );
 3470  0
                 append( sb, "", 0 );
 3471  
 
 3472  0
                 append( sb, "dependencySourceExcludes", 2 );
 3473  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 3474  0
                 append( sb, "", 0 );
 3475  
 
 3476  0
                 append( sb, "dependencySourceIncludes", 2 );
 3477  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 3478  0
                 append( sb, "", 0 );
 3479  
 
 3480  0
                 append( sb, "description", 2 );
 3481  0
                 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 3482  0
                 append( sb, "", 0 );
 3483  
 
 3484  0
                 append( sb, "destDir (Default: testapidocs)", 2 );
 3485  0
                 append( sb, "The name of the destination directory.\n", 3 );
 3486  0
                 append( sb, "", 0 );
 3487  
 
 3488  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 3489  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 3490  0
                 append( sb, "", 0 );
 3491  
 
 3492  0
                 append( sb, "detectLinks (Default: false)", 2 );
 3493  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 );
 3494  0
                 append( sb, "", 0 );
 3495  
 
 3496  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 3497  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 );
 3498  0
                 append( sb, "", 0 );
 3499  
 
 3500  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 3501  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 3502  0
                 append( sb, "", 0 );
 3503  
 
 3504  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 3505  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 );
 3506  0
                 append( sb, "", 0 );
 3507  
 
 3508  0
                 append( sb, "doclet", 2 );
 3509  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 3510  0
                 append( sb, "", 0 );
 3511  
 
 3512  0
                 append( sb, "docletArtifact", 2 );
 3513  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 );
 3514  0
                 append( sb, "", 0 );
 3515  
 
 3516  0
                 append( sb, "docletArtifacts", 2 );
 3517  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 );
 3518  0
                 append( sb, "", 0 );
 3519  
 
 3520  0
                 append( sb, "docletPath", 2 );
 3521  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 );
 3522  0
                 append( sb, "", 0 );
 3523  
 
 3524  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 3525  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3526  0
                 append( sb, "", 0 );
 3527  
 
 3528  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3529  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 );
 3530  0
                 append( sb, "", 0 );
 3531  
 
 3532  0
                 append( sb, "excludedocfilessubdir", 2 );
 3533  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 );
 3534  0
                 append( sb, "", 0 );
 3535  
 
 3536  0
                 append( sb, "excludePackageNames", 2 );
 3537  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 );
 3538  0
                 append( sb, "", 0 );
 3539  
 
 3540  0
                 append( sb, "extdirs", 2 );
 3541  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 3542  0
                 append( sb, "", 0 );
 3543  
 
 3544  0
                 append( sb, "failOnError (Default: true)", 2 );
 3545  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 3546  0
                 append( sb, "", 0 );
 3547  
 
 3548  0
                 append( sb, "footer", 2 );
 3549  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 3550  0
                 append( sb, "", 0 );
 3551  
 
 3552  0
                 append( sb, "groups", 2 );
 3553  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 );
 3554  0
                 append( sb, "", 0 );
 3555  
 
 3556  0
                 append( sb, "header", 2 );
 3557  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 3558  0
                 append( sb, "", 0 );
 3559  
 
 3560  0
                 append( sb, "helpfile", 2 );
 3561  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 );
 3562  0
                 append( sb, "", 0 );
 3563  
 
 3564  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 3565  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 );
 3566  0
                 append( sb, "", 0 );
 3567  
 
 3568  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 3569  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 3570  0
                 append( sb, "", 0 );
 3571  
 
 3572  0
                 append( sb, "javaApiLinks", 2 );
 3573  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 );
 3574  0
                 append( sb, "", 0 );
 3575  
 
 3576  0
                 append( sb, "javadocDirectory", 2 );
 3577  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 );
 3578  0
                 append( sb, "", 0 );
 3579  
 
 3580  0
                 append( sb, "javadocExecutable", 2 );
 3581  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 );
 3582  0
                 append( sb, "", 0 );
 3583  
 
 3584  0
                 append( sb, "javadocVersion", 2 );
 3585  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 3586  0
                 append( sb, "", 0 );
 3587  
 
 3588  0
                 append( sb, "keywords (Default: false)", 2 );
 3589  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 );
 3590  0
                 append( sb, "", 0 );
 3591  
 
 3592  0
                 append( sb, "links", 2 );
 3593  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 3594  0
                 append( sb, "", 0 );
 3595  
 
 3596  0
                 append( sb, "linksource (Default: false)", 2 );
 3597  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 );
 3598  0
                 append( sb, "", 0 );
 3599  
 
 3600  0
                 append( sb, "locale", 2 );
 3601  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 3602  0
                 append( sb, "", 0 );
 3603  
 
 3604  0
                 append( sb, "localRepository", 2 );
 3605  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 3606  0
                 append( sb, "", 0 );
 3607  
 
 3608  0
                 append( sb, "maxmemory", 2 );
 3609  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 );
 3610  0
                 append( sb, "", 0 );
 3611  
 
 3612  0
                 append( sb, "minmemory", 2 );
 3613  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 );
 3614  0
                 append( sb, "", 0 );
 3615  
 
 3616  0
                 append( sb, "name", 2 );
 3617  0
                 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
 3618  0
                 append( sb, "", 0 );
 3619  
 
 3620  0
                 append( sb, "nocomment (Default: false)", 2 );
 3621  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 );
 3622  0
                 append( sb, "", 0 );
 3623  
 
 3624  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 3625  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 3626  0
                 append( sb, "", 0 );
 3627  
 
 3628  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 3629  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 );
 3630  0
                 append( sb, "", 0 );
 3631  
 
 3632  0
                 append( sb, "nohelp (Default: false)", 2 );
 3633  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 );
 3634  0
                 append( sb, "", 0 );
 3635  
 
 3636  0
                 append( sb, "noindex (Default: false)", 2 );
 3637  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 3638  0
                 append( sb, "", 0 );
 3639  
 
 3640  0
                 append( sb, "nonavbar (Default: false)", 2 );
 3641  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 3642  0
                 append( sb, "", 0 );
 3643  
 
 3644  0
                 append( sb, "nooverview (Default: false)", 2 );
 3645  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 );
 3646  0
                 append( sb, "", 0 );
 3647  
 
 3648  0
                 append( sb, "noqualifier", 2 );
 3649  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 );
 3650  0
                 append( sb, "", 0 );
 3651  
 
 3652  0
                 append( sb, "nosince (Default: false)", 2 );
 3653  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 3654  0
                 append( sb, "", 0 );
 3655  
 
 3656  0
                 append( sb, "notimestamp (Default: false)", 2 );
 3657  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 );
 3658  0
                 append( sb, "", 0 );
 3659  
 
 3660  0
                 append( sb, "notree (Default: false)", 2 );
 3661  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 3662  0
                 append( sb, "", 0 );
 3663  
 
 3664  0
                 append( sb, "offlineLinks", 2 );
 3665  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://java.sun.com/j2se/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 );
 3666  0
                 append( sb, "", 0 );
 3667  
 
 3668  0
                 append( sb, "old (Default: false)", 2 );
 3669  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 3670  0
                 append( sb, "", 0 );
 3671  
 
 3672  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 3673  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 3674  0
                 append( sb, "", 0 );
 3675  
 
 3676  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 3677  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 );
 3678  0
                 append( sb, "", 0 );
 3679  
 
 3680  0
                 append( sb, "packagesheader", 2 );
 3681  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 3682  0
                 append( sb, "", 0 );
 3683  
 
 3684  0
                 append( sb, "proxyHost", 2 );
 3685  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 3686  0
                 append( sb, "", 0 );
 3687  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 );
 3688  0
                 append( sb, "", 0 );
 3689  
 
 3690  0
                 append( sb, "proxyPort", 2 );
 3691  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 3692  0
                 append( sb, "", 0 );
 3693  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 );
 3694  0
                 append( sb, "", 0 );
 3695  
 
 3696  0
                 append( sb, "quiet (Default: false)", 2 );
 3697  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 );
 3698  0
                 append( sb, "", 0 );
 3699  
 
 3700  0
                 append( sb, "remoteRepositories", 2 );
 3701  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 3702  0
                 append( sb, "", 0 );
 3703  
 
 3704  0
                 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
 3705  0
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 3706  0
                 append( sb, "", 0 );
 3707  
 
 3708  0
                 append( sb, "resourcesArtifacts", 2 );
 3709  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 );
 3710  0
                 append( sb, "", 0 );
 3711  
 
 3712  0
                 append( sb, "serialwarn (Default: false)", 2 );
 3713  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 3714  0
                 append( sb, "", 0 );
 3715  
 
 3716  0
                 append( sb, "show (Default: protected)", 2 );
 3717  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 );
 3718  0
                 append( sb, "", 0 );
 3719  
 
 3720  0
                 append( sb, "skip (Default: false)", 2 );
 3721  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 3722  0
                 append( sb, "", 0 );
 3723  
 
 3724  0
                 append( sb, "source", 2 );
 3725  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 );
 3726  0
                 append( sb, "", 0 );
 3727  
 
 3728  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 3729  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 3730  0
                 append( sb, "", 0 );
 3731  
 
 3732  0
                 append( sb, "sourcepath", 2 );
 3733  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 );
 3734  0
                 append( sb, "", 0 );
 3735  
 
 3736  0
                 append( sb, "sourcetab", 2 );
 3737  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 );
 3738  0
                 append( sb, "", 0 );
 3739  
 
 3740  0
                 append( sb, "splitindex (Default: false)", 2 );
 3741  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 );
 3742  0
                 append( sb, "", 0 );
 3743  
 
 3744  0
                 append( sb, "stylesheet (Default: java)", 2 );
 3745  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 );
 3746  0
                 append( sb, "", 0 );
 3747  
 
 3748  0
                 append( sb, "stylesheetfile", 2 );
 3749  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 );
 3750  0
                 append( sb, "", 0 );
 3751  
 
 3752  0
                 append( sb, "subpackages", 2 );
 3753  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 );
 3754  0
                 append( sb, "", 0 );
 3755  
 
 3756  0
                 append( sb, "taglet", 2 );
 3757  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 );
 3758  0
                 append( sb, "", 0 );
 3759  
 
 3760  0
                 append( sb, "tagletArtifact", 2 );
 3761  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 );
 3762  0
                 append( sb, "", 0 );
 3763  
 
 3764  0
                 append( sb, "tagletArtifacts", 2 );
 3765  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 );
 3766  0
                 append( sb, "", 0 );
 3767  
 
 3768  0
                 append( sb, "tagletpath", 2 );
 3769  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 );
 3770  0
                 append( sb, "", 0 );
 3771  
 
 3772  0
                 append( sb, "taglets", 2 );
 3773  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 );
 3774  0
                 append( sb, "", 0 );
 3775  
 
 3776  0
                 append( sb, "tags", 2 );
 3777  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 );
 3778  0
                 append( sb, "", 0 );
 3779  
 
 3780  0
                 append( sb, "testDescription", 2 );
 3781  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 );
 3782  0
                 append( sb, "", 0 );
 3783  
 
 3784  0
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3785  0
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3786  0
                 append( sb, "", 0 );
 3787  
 
 3788  0
                 append( sb, "testJavadocDirectory", 2 );
 3789  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 );
 3790  0
                 append( sb, "", 0 );
 3791  
 
 3792  0
                 append( sb, "testName", 2 );
 3793  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 );
 3794  0
                 append( sb, "", 0 );
 3795  
 
 3796  0
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 3797  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 );
 3798  0
                 append( sb, "", 0 );
 3799  
 
 3800  0
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 3801  0
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3802  0
                 append( sb, "", 0 );
 3803  
 
 3804  0
                 append( sb, "top", 2 );
 3805  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 3806  0
                 append( sb, "", 0 );
 3807  
 
 3808  0
                 append( sb, "use (Default: true)", 2 );
 3809  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 3810  0
                 append( sb, "", 0 );
 3811  
 
 3812  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 3813  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 );
 3814  0
                 append( sb, "", 0 );
 3815  
 
 3816  0
                 append( sb, "verbose (Default: false)", 2 );
 3817  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 3818  0
                 append( sb, "", 0 );
 3819  
 
 3820  0
                 append( sb, "version (Default: true)", 2 );
 3821  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 3822  0
                 append( sb, "", 0 );
 3823  
 
 3824  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 3825  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 3826  0
                 append( sb, "", 0 );
 3827  
             }
 3828  
         }
 3829  
 
 3830  0
         if ( goal == null || goal.length() <= 0 || "test-resource-bundle".equals( goal ) )
 3831  
         {
 3832  0
             append( sb, "javadoc:test-resource-bundle", 0 );
 3833  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 );
 3834  0
             append( sb, "", 0 );
 3835  0
             if ( detail )
 3836  
             {
 3837  0
                 append( sb, "Available parameters:", 1 );
 3838  0
                 append( sb, "", 0 );
 3839  
 
 3840  0
                 append( sb, "additionalJOption", 2 );
 3841  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 );
 3842  0
                 append( sb, "", 0 );
 3843  
 
 3844  0
                 append( sb, "additionalparam", 2 );
 3845  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 );
 3846  0
                 append( sb, "", 0 );
 3847  
 
 3848  0
                 append( sb, "aggregate (Default: false)", 2 );
 3849  0
                 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 3850  0
                 append( sb, "", 0 );
 3851  0
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 3852  0
                 append( sb, "", 0 );
 3853  
 
 3854  0
                 append( sb, "author (Default: true)", 2 );
 3855  0
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 3856  0
                 append( sb, "", 0 );
 3857  
 
 3858  0
                 append( sb, "bootclasspath", 2 );
 3859  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 );
 3860  0
                 append( sb, "", 0 );
 3861  
 
 3862  0
                 append( sb, "bootclasspathArtifacts", 2 );
 3863  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 );
 3864  0
                 append( sb, "", 0 );
 3865  
 
 3866  0
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 3867  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 );
 3868  0
                 append( sb, "", 0 );
 3869  
 
 3870  0
                 append( sb, "breakiterator (Default: false)", 2 );
 3871  0
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 3872  0
                 append( sb, "", 0 );
 3873  
 
 3874  0
                 append( sb, "charset", 2 );
 3875  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 );
 3876  0
                 append( sb, "", 0 );
 3877  
 
 3878  0
                 append( sb, "debug (Default: false)", 2 );
 3879  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 );
 3880  0
                 append( sb, "", 0 );
 3881  
 
 3882  0
                 append( sb, "dependencySourceExcludes", 2 );
 3883  0
                 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
 3884  0
                 append( sb, "", 0 );
 3885  
 
 3886  0
                 append( sb, "dependencySourceIncludes", 2 );
 3887  0
                 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
 3888  0
                 append( sb, "", 0 );
 3889  
 
 3890  0
                 append( sb, "detectJavaApiLink (Default: true)", 2 );
 3891  0
                 append( sb, "Detect the Java API link for the current build, i.e. http://java.sun.com/j2se/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 );
 3892  0
                 append( sb, "", 0 );
 3893  
 
 3894  0
                 append( sb, "detectLinks (Default: false)", 2 );
 3895  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 );
 3896  0
                 append( sb, "", 0 );
 3897  
 
 3898  0
                 append( sb, "detectOfflineLinks (Default: true)", 2 );
 3899  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 );
 3900  0
                 append( sb, "", 0 );
 3901  
 
 3902  0
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 3903  0
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 3904  0
                 append( sb, "", 0 );
 3905  
 
 3906  0
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 3907  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 );
 3908  0
                 append( sb, "", 0 );
 3909  
 
 3910  0
                 append( sb, "doclet", 2 );
 3911  0
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 3912  0
                 append( sb, "", 0 );
 3913  
 
 3914  0
                 append( sb, "docletArtifact", 2 );
 3915  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 );
 3916  0
                 append( sb, "", 0 );
 3917  
 
 3918  0
                 append( sb, "docletArtifacts", 2 );
 3919  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 );
 3920  0
                 append( sb, "", 0 );
 3921  
 
 3922  0
                 append( sb, "docletPath", 2 );
 3923  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 );
 3924  0
                 append( sb, "", 0 );
 3925  
 
 3926  0
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 3927  0
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 3928  0
                 append( sb, "", 0 );
 3929  
 
 3930  0
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 3931  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 );
 3932  0
                 append( sb, "", 0 );
 3933  
 
 3934  0
                 append( sb, "excludedocfilessubdir", 2 );
 3935  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 );
 3936  0
                 append( sb, "", 0 );
 3937  
 
 3938  0
                 append( sb, "excludePackageNames", 2 );
 3939  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 );
 3940  0
                 append( sb, "", 0 );
 3941  
 
 3942  0
                 append( sb, "extdirs", 2 );
 3943  0
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
 3944  0
                 append( sb, "", 0 );
 3945  
 
 3946  0
                 append( sb, "failOnError (Default: true)", 2 );
 3947  0
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 3948  0
                 append( sb, "", 0 );
 3949  
 
 3950  0
                 append( sb, "footer", 2 );
 3951  0
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 3952  0
                 append( sb, "", 0 );
 3953  
 
 3954  0
                 append( sb, "groups", 2 );
 3955  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 );
 3956  0
                 append( sb, "", 0 );
 3957  
 
 3958  0
                 append( sb, "header", 2 );
 3959  0
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 3960  0
                 append( sb, "", 0 );
 3961  
 
 3962  0
                 append( sb, "helpfile", 2 );
 3963  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 );
 3964  0
                 append( sb, "", 0 );
 3965  
 
 3966  0
                 append( sb, "includeDependencySources (Default: false)", 2 );
 3967  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 );
 3968  0
                 append( sb, "", 0 );
 3969  
 
 3970  0
                 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
 3971  0
                 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
 3972  0
                 append( sb, "", 0 );
 3973  
 
 3974  0
                 append( sb, "javaApiLinks", 2 );
 3975  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 );
 3976  0
                 append( sb, "", 0 );
 3977  
 
 3978  0
                 append( sb, "javadocDirectory", 2 );
 3979  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 );
 3980  0
                 append( sb, "", 0 );
 3981  
 
 3982  0
                 append( sb, "javadocExecutable", 2 );
 3983  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 );
 3984  0
                 append( sb, "", 0 );
 3985  
 
 3986  0
                 append( sb, "javadocVersion", 2 );
 3987  0
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 3988  0
                 append( sb, "", 0 );
 3989  
 
 3990  0
                 append( sb, "keywords (Default: false)", 2 );
 3991  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 );
 3992  0
                 append( sb, "", 0 );
 3993  
 
 3994  0
                 append( sb, "links", 2 );
 3995  0
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used is 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://java.sun.com/j2se/1.4.2/docs/api</link>\n<links>\n\twill be used because http://java.sun.com/j2se/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 verion of the project\'s sources, will be added automatically.\nSee link.", 3 );
 3996  0
                 append( sb, "", 0 );
 3997  
 
 3998  0
                 append( sb, "linksource (Default: false)", 2 );
 3999  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 );
 4000  0
                 append( sb, "", 0 );
 4001  
 
 4002  0
                 append( sb, "locale", 2 );
 4003  0
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 4004  0
                 append( sb, "", 0 );
 4005  
 
 4006  0
                 append( sb, "localRepository", 2 );
 4007  0
                 append( sb, "The local repository where the artifacts are located.", 3 );
 4008  0
                 append( sb, "", 0 );
 4009  
 
 4010  0
                 append( sb, "maxmemory", 2 );
 4011  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 );
 4012  0
                 append( sb, "", 0 );
 4013  
 
 4014  0
                 append( sb, "minmemory", 2 );
 4015  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 );
 4016  0
                 append( sb, "", 0 );
 4017  
 
 4018  0
                 append( sb, "nocomment (Default: false)", 2 );
 4019  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 );
 4020  0
                 append( sb, "", 0 );
 4021  
 
 4022  0
                 append( sb, "nodeprecated (Default: false)", 2 );
 4023  0
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 4024  0
                 append( sb, "", 0 );
 4025  
 
 4026  0
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 4027  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 );
 4028  0
                 append( sb, "", 0 );
 4029  
 
 4030  0
                 append( sb, "nohelp (Default: false)", 2 );
 4031  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 );
 4032  0
                 append( sb, "", 0 );
 4033  
 
 4034  0
                 append( sb, "noindex (Default: false)", 2 );
 4035  0
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 4036  0
                 append( sb, "", 0 );
 4037  
 
 4038  0
                 append( sb, "nonavbar (Default: false)", 2 );
 4039  0
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 4040  0
                 append( sb, "", 0 );
 4041  
 
 4042  0
                 append( sb, "nooverview (Default: false)", 2 );
 4043  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 );
 4044  0
                 append( sb, "", 0 );
 4045  
 
 4046  0
                 append( sb, "noqualifier", 2 );
 4047  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 );
 4048  0
                 append( sb, "", 0 );
 4049  
 
 4050  0
                 append( sb, "nosince (Default: false)", 2 );
 4051  0
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 4052  0
                 append( sb, "", 0 );
 4053  
 
 4054  0
                 append( sb, "notimestamp (Default: false)", 2 );
 4055  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 );
 4056  0
                 append( sb, "", 0 );
 4057  
 
 4058  0
                 append( sb, "notree (Default: false)", 2 );
 4059  0
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 4060  0
                 append( sb, "", 0 );
 4061  
 
 4062  0
                 append( sb, "offlineLinks", 2 );
 4063  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://java.sun.com/j2se/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 );
 4064  0
                 append( sb, "", 0 );
 4065  
 
 4066  0
                 append( sb, "old (Default: false)", 2 );
 4067  0
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 4068  0
                 append( sb, "", 0 );
 4069  
 
 4070  0
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 4071  0
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 4072  0
                 append( sb, "", 0 );
 4073  
 
 4074  0
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 4075  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 );
 4076  0
                 append( sb, "", 0 );
 4077  
 
 4078  0
                 append( sb, "packagesheader", 2 );
 4079  0
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 4080  0
                 append( sb, "", 0 );
 4081  
 
 4082  0
                 append( sb, "proxyHost", 2 );
 4083  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 4084  0
                 append( sb, "", 0 );
 4085  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 );
 4086  0
                 append( sb, "", 0 );
 4087  
 
 4088  0
                 append( sb, "proxyPort", 2 );
 4089  0
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 4090  0
                 append( sb, "", 0 );
 4091  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 );
 4092  0
                 append( sb, "", 0 );
 4093  
 
 4094  0
                 append( sb, "quiet (Default: false)", 2 );
 4095  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 );
 4096  0
                 append( sb, "", 0 );
 4097  
 
 4098  0
                 append( sb, "remoteRepositories", 2 );
 4099  0
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 4100  0
                 append( sb, "", 0 );
 4101  
 
 4102  0
                 append( sb, "resourcesArtifacts", 2 );
 4103  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 );
 4104  0
                 append( sb, "", 0 );
 4105  
 
 4106  0
                 append( sb, "serialwarn (Default: false)", 2 );
 4107  0
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 4108  0
                 append( sb, "", 0 );
 4109  
 
 4110  0
                 append( sb, "show (Default: protected)", 2 );
 4111  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 );
 4112  0
                 append( sb, "", 0 );
 4113  
 
 4114  0
                 append( sb, "skip (Default: false)", 2 );
 4115  0
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 4116  0
                 append( sb, "", 0 );
 4117  
 
 4118  0
                 append( sb, "source", 2 );
 4119  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 );
 4120  0
                 append( sb, "", 0 );
 4121  
 
 4122  0
                 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
 4123  0
                 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
 4124  0
                 append( sb, "", 0 );
 4125  
 
 4126  0
                 append( sb, "sourcepath", 2 );
 4127  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 );
 4128  0
                 append( sb, "", 0 );
 4129  
 
 4130  0
                 append( sb, "sourcetab", 2 );
 4131  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 );
 4132  0
                 append( sb, "", 0 );
 4133  
 
 4134  0
                 append( sb, "splitindex (Default: false)", 2 );
 4135  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 );
 4136  0
                 append( sb, "", 0 );
 4137  
 
 4138  0
                 append( sb, "stylesheet (Default: java)", 2 );
 4139  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 );
 4140  0
                 append( sb, "", 0 );
 4141  
 
 4142  0
                 append( sb, "stylesheetfile", 2 );
 4143  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 );
 4144  0
                 append( sb, "", 0 );
 4145  
 
 4146  0
                 append( sb, "subpackages", 2 );
 4147  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 );
 4148  0
                 append( sb, "", 0 );
 4149  
 
 4150  0
                 append( sb, "taglet", 2 );
 4151  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 );
 4152  0
                 append( sb, "", 0 );
 4153  
 
 4154  0
                 append( sb, "tagletArtifact", 2 );
 4155  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 );
 4156  0
                 append( sb, "", 0 );
 4157  
 
 4158  0
                 append( sb, "tagletArtifacts", 2 );
 4159  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 );
 4160  0
                 append( sb, "", 0 );
 4161  
 
 4162  0
                 append( sb, "tagletpath", 2 );
 4163  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 );
 4164  0
                 append( sb, "", 0 );
 4165  
 
 4166  0
                 append( sb, "taglets", 2 );
 4167  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 );
 4168  0
                 append( sb, "", 0 );
 4169  
 
 4170  0
                 append( sb, "tags", 2 );
 4171  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 );
 4172  0
                 append( sb, "", 0 );
 4173  
 
 4174  0
                 append( sb, "testJavadocDirectory (Default: ${basedir}/src/test/javadoc)", 2 );
 4175  0
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 4176  0
                 append( sb, "", 0 );
 4177  
 
 4178  0
                 append( sb, "top", 2 );
 4179  0
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 4180  0
                 append( sb, "", 0 );
 4181  
 
 4182  0
                 append( sb, "use (Default: true)", 2 );
 4183  0
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 4184  0
                 append( sb, "", 0 );
 4185  
 
 4186  0
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 4187  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 );
 4188  0
                 append( sb, "", 0 );
 4189  
 
 4190  0
                 append( sb, "verbose (Default: false)", 2 );
 4191  0
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 4192  0
                 append( sb, "", 0 );
 4193  
 
 4194  0
                 append( sb, "version (Default: true)", 2 );
 4195  0
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 4196  0
                 append( sb, "", 0 );
 4197  
 
 4198  0
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 4199  0
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 4200  0
                 append( sb, "", 0 );
 4201  
             }
 4202  
         }
 4203  
 
 4204  0
         if ( getLog().isInfoEnabled() )
 4205  
         {
 4206  0
             getLog().info( sb.toString() );
 4207  
         }
 4208  0
     }
 4209  
 
 4210  
     /**
 4211  
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 4212  
      *
 4213  
      * @param str String to repeat
 4214  
      * @param repeat number of times to repeat str
 4215  
      * @return String with repeated String
 4216  
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 4217  
      * @throws NullPointerException if str is <code>null</code>
 4218  
      */
 4219  
     private static String repeat( String str, int repeat )
 4220  
     {
 4221  0
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 4222  
 
 4223  0
         for ( int i = 0; i < repeat; i++ )
 4224  
         {
 4225  0
             buffer.append( str );
 4226  
         }
 4227  
 
 4228  0
         return buffer.toString();
 4229  
     }
 4230  
 
 4231  
     /** 
 4232  
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 4233  
      * <b>Note</b>: The last character is always a new line.
 4234  
      * 
 4235  
      * @param sb The buffer to append the description, not <code>null</code>.
 4236  
      * @param description The description, not <code>null</code>.
 4237  
      * @param indent The base indentation level of each line, must not be negative.
 4238  
      */
 4239  
     private void append( StringBuffer sb, String description, int indent )
 4240  
     {
 4241  0
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 4242  
         {
 4243  0
             sb.append( it.next().toString() ).append( '\n' );
 4244  
         }
 4245  0
     }
 4246  
 
 4247  
     /** 
 4248  
      * Splits the specified text into lines of convenient display length.
 4249  
      * 
 4250  
      * @param text The text to split into lines, must not be <code>null</code>.
 4251  
      * @param indent The base indentation level of each line, must not be negative.
 4252  
      * @param indentSize The size of each indentation, must not be negative.
 4253  
      * @param lineLength The length of the line, must not be negative.
 4254  
      * @return The sequence of display lines, never <code>null</code>.
 4255  
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 4256  
      */
 4257  
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 4258  
     {
 4259  0
         List lines = new ArrayList();
 4260  
 
 4261  0
         String ind = repeat( "\t", indent );
 4262  0
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 4263  0
         for ( int i = 0; i < plainLines.length; i++ )
 4264  
         {
 4265  0
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 4266  
         }
 4267  
 
 4268  0
         return lines;
 4269  
     }
 4270  
 
 4271  
     /** 
 4272  
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 4273  
      * 
 4274  
      * @param lines The sequence of display lines, must not be <code>null</code>.
 4275  
      * @param line The line to add, must not be <code>null</code>.
 4276  
      * @param indentSize The size of each indentation, must not be negative.
 4277  
      * @param lineLength The length of the line, must not be negative.
 4278  
      */
 4279  
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 4280  
     {
 4281  0
         int lineIndent = getIndentLevel( line );
 4282  0
         StringBuffer buf = new StringBuffer( 256 );
 4283  0
         String[] tokens = line.split( " +" );
 4284  0
         for ( int i = 0; i < tokens.length; i++ )
 4285  
         {
 4286  0
             String token = tokens[i];
 4287  0
             if ( i > 0 )
 4288  
             {
 4289  0
                 if ( buf.length() + token.length() >= lineLength )
 4290  
                 {
 4291  0
                     lines.add( buf.toString() );
 4292  0
                     buf.setLength( 0 );
 4293  0
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 4294  
                 }
 4295  
                 else
 4296  
                 {
 4297  0
                     buf.append( ' ' );
 4298  
                 }
 4299  
             }
 4300  0
             for ( int j = 0; j < token.length(); j++ )
 4301  
             {
 4302  0
                 char c = token.charAt( j );
 4303  0
                 if ( c == '\t' )
 4304  
                 {
 4305  0
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 4306  
                 }
 4307  0
                 else if ( c == '\u00A0' )
 4308  
                 {
 4309  0
                     buf.append( ' ' );
 4310  
                 }
 4311  
                 else
 4312  
                 {
 4313  0
                     buf.append( c );
 4314  
                 }
 4315  
             }
 4316  
         }
 4317  0
         lines.add( buf.toString() );
 4318  0
     }
 4319  
 
 4320  
     /** 
 4321  
      * Gets the indentation level of the specified line.
 4322  
      * 
 4323  
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 4324  
      * @return The indentation level of the line.
 4325  
      */
 4326  
     private static int getIndentLevel( String line )
 4327  
     {
 4328  0
         int level = 0;
 4329  0
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 4330  
         {
 4331  0
             level++;
 4332  
         }
 4333  0
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 4334  
         {
 4335  0
             if ( line.charAt( i ) == '\t' )
 4336  
             {
 4337  0
                 level++;
 4338  0
                 break;
 4339  
             }
 4340  
         }
 4341  0
         return level;
 4342  
     }
 4343  
 }