Coverage Report - org.apache.maven.plugin.javadoc.HelpMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
HelpMojo
0 %
0/1711
0 %
0/94
6
 
 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 Aug 22 07:33:04 EDT 2008
 14   
  * @author org.apache.maven.tools.plugin.generator.PluginHelpGenerator (version 2.4.3)
 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.5", 0 );
 68  0 
         append( sb, "", 0 );
 69   
 
 70  0 
         append( sb, "Maven Javadoc Plugin 2.5", 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 7 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.", 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. As of version 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.\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 Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 130  0 
                 append( sb, "", 0 );
 131   
 
 132  0 
                 append( sb, "description", 2 );
 133  0 
                 append( sb, "The description of the Javadoc report.", 3 );
 134  0 
                 append( sb, "", 0 );
 135   
 
 136  0 
                 append( sb, "destDir (Default: apidocs)", 2 );
 137  0 
                 append( sb, "The name of the destination directory.\n", 3 );
 138  0 
                 append( sb, "", 0 );
 139   
 
 140  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 141  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 142  0 
                 append( sb, "", 0 );
 143   
 
 144  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 145  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 146  0 
                 append( sb, "", 0 );
 147   
 
 148  0 
                 append( sb, "doclet", 2 );
 149  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 150  0 
                 append( sb, "", 0 );
 151   
 
 152  0 
                 append( sb, "docletArtifact", 2 );
 153  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 );
 154  0 
                 append( sb, "", 0 );
 155   
 
 156  0 
                 append( sb, "docletArtifacts", 2 );
 157  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 );
 158  0 
                 append( sb, "", 0 );
 159   
 
 160  0 
                 append( sb, "docletPath", 2 );
 161  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 162  0 
                 append( sb, "", 0 );
 163   
 
 164  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 165  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 166  0 
                 append( sb, "", 0 );
 167   
 
 168  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 169  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 );
 170  0 
                 append( sb, "", 0 );
 171   
 
 172  0 
                 append( sb, "excludePackageNames", 2 );
 173  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 174  0 
                 append( sb, "", 0 );
 175   
 
 176  0 
                 append( sb, "excludedocfilessubdir", 2 );
 177  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 );
 178  0 
                 append( sb, "", 0 );
 179   
 
 180  0 
                 append( sb, "extdirs", 2 );
 181  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 182  0 
                 append( sb, "", 0 );
 183   
 
 184  0 
                 append( sb, "failOnError (Default: true)", 2 );
 185  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 186  0 
                 append( sb, "", 0 );
 187   
 
 188  0 
                 append( sb, "footer", 2 );
 189  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 190  0 
                 append( sb, "", 0 );
 191   
 
 192  0 
                 append( sb, "groups", 2 );
 193  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 194  0 
                 append( sb, "", 0 );
 195   
 
 196  0 
                 append( sb, "header", 2 );
 197  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 198  0 
                 append( sb, "", 0 );
 199   
 
 200  0 
                 append( sb, "helpfile", 2 );
 201  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/>.\nSee helpfile.", 3 );
 202  0 
                 append( sb, "", 0 );
 203   
 
 204  0 
                 append( sb, "javadocDirectory", 2 );
 205  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 );
 206  0 
                 append( sb, "", 0 );
 207   
 
 208  0 
                 append( sb, "javadocExecutable", 2 );
 209  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 );
 210  0 
                 append( sb, "", 0 );
 211   
 
 212  0 
                 append( sb, "javadocVersion", 2 );
 213  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 214  0 
                 append( sb, "", 0 );
 215   
 
 216  0 
                 append( sb, "keywords (Default: false)", 2 );
 217  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 );
 218  0 
                 append( sb, "", 0 );
 219   
 
 220  0 
                 append( sb, "links", 2 );
 221  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 222  0 
                 append( sb, "", 0 );
 223   
 
 224  0 
                 append( sb, "linksource (Default: false)", 2 );
 225  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 );
 226  0 
                 append( sb, "", 0 );
 227   
 
 228  0 
                 append( sb, "localRepository", 2 );
 229  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 230  0 
                 append( sb, "", 0 );
 231   
 
 232  0 
                 append( sb, "locale", 2 );
 233  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 234  0 
                 append( sb, "", 0 );
 235   
 
 236  0 
                 append( sb, "maxmemory", 2 );
 237  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 );
 238  0 
                 append( sb, "", 0 );
 239   
 
 240  0 
                 append( sb, "minmemory", 2 );
 241  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 );
 242  0 
                 append( sb, "", 0 );
 243   
 
 244  0 
                 append( sb, "name", 2 );
 245  0 
                 append( sb, "The name of the Javadoc report.", 3 );
 246  0 
                 append( sb, "", 0 );
 247   
 
 248  0 
                 append( sb, "nocomment (Default: false)", 2 );
 249  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 );
 250  0 
                 append( sb, "", 0 );
 251   
 
 252  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 253  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 254  0 
                 append( sb, "", 0 );
 255   
 
 256  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 257  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 );
 258  0 
                 append( sb, "", 0 );
 259   
 
 260  0 
                 append( sb, "nohelp (Default: false)", 2 );
 261  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 );
 262  0 
                 append( sb, "", 0 );
 263   
 
 264  0 
                 append( sb, "noindex (Default: false)", 2 );
 265  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 266  0 
                 append( sb, "", 0 );
 267   
 
 268  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 269  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 270  0 
                 append( sb, "", 0 );
 271   
 
 272  0 
                 append( sb, "nooverview (Default: false)", 2 );
 273  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 );
 274  0 
                 append( sb, "", 0 );
 275   
 
 276  0 
                 append( sb, "noqualifier", 2 );
 277  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 278  0 
                 append( sb, "", 0 );
 279   
 
 280  0 
                 append( sb, "nosince (Default: false)", 2 );
 281  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 282  0 
                 append( sb, "", 0 );
 283   
 
 284  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 285  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 );
 286  0 
                 append( sb, "", 0 );
 287   
 
 288  0 
                 append( sb, "notree (Default: false)", 2 );
 289  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 290  0 
                 append( sb, "", 0 );
 291   
 
 292  0 
                 append( sb, "offlineLinks", 2 );
 293  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\nSee Javadoc.\n", 3 );
 294  0 
                 append( sb, "", 0 );
 295   
 
 296  0 
                 append( sb, "old (Default: false)", 2 );
 297  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 298  0 
                 append( sb, "", 0 );
 299   
 
 300  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 301  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 302  0 
                 append( sb, "", 0 );
 303   
 
 304  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 305  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 );
 306  0 
                 append( sb, "", 0 );
 307   
 
 308  0 
                 append( sb, "packagesheader", 2 );
 309  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 310  0 
                 append( sb, "", 0 );
 311   
 
 312  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 313  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 314  0 
                 append( sb, "", 0 );
 315  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 );
 316  0 
                 append( sb, "", 0 );
 317   
 
 318  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 319  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 320  0 
                 append( sb, "", 0 );
 321  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 );
 322  0 
                 append( sb, "", 0 );
 323   
 
 324  0 
                 append( sb, "quiet (Default: false)", 2 );
 325  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 );
 326  0 
                 append( sb, "", 0 );
 327   
 
 328  0 
                 append( sb, "remoteRepositories", 2 );
 329  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 330  0 
                 append( sb, "", 0 );
 331   
 
 332  0 
                 append( sb, "reportOutputDirectory", 2 );
 333  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 334  0 
                 append( sb, "", 0 );
 335   
 
 336  0 
                 append( sb, "resourcesArtifacts", 2 );
 337  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 );
 338  0 
                 append( sb, "", 0 );
 339   
 
 340  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 341  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 342  0 
                 append( sb, "", 0 );
 343   
 
 344  0 
                 append( sb, "show (Default: protected)", 2 );
 345  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 );
 346  0 
                 append( sb, "", 0 );
 347   
 
 348  0 
                 append( sb, "skip (Default: false)", 2 );
 349  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 350  0 
                 append( sb, "", 0 );
 351   
 
 352  0 
                 append( sb, "source", 2 );
 353  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 );
 354  0 
                 append( sb, "", 0 );
 355   
 
 356  0 
                 append( sb, "sourcepath", 2 );
 357  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 358  0 
                 append( sb, "", 0 );
 359   
 
 360  0 
                 append( sb, "sourcetab", 2 );
 361  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 );
 362  0 
                 append( sb, "", 0 );
 363   
 
 364  0 
                 append( sb, "splitindex (Default: false)", 2 );
 365  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 );
 366  0 
                 append( sb, "", 0 );
 367   
 
 368  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 369  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 370  0 
                 append( sb, "", 0 );
 371   
 
 372  0 
                 append( sb, "stylesheetfile", 2 );
 373  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 374  0 
                 append( sb, "", 0 );
 375   
 
 376  0 
                 append( sb, "subpackages", 2 );
 377  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 );
 378  0 
                 append( sb, "", 0 );
 379   
 
 380  0 
                 append( sb, "taglet", 2 );
 381  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 );
 382  0 
                 append( sb, "", 0 );
 383   
 
 384  0 
                 append( sb, "tagletArtifact", 2 );
 385  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 );
 386  0 
                 append( sb, "", 0 );
 387   
 
 388  0 
                 append( sb, "tagletArtifacts", 2 );
 389  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 );
 390  0 
                 append( sb, "", 0 );
 391   
 
 392  0 
                 append( sb, "tagletpath", 2 );
 393  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 394  0 
                 append( sb, "", 0 );
 395   
 
 396  0 
                 append( sb, "taglets", 2 );
 397  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 );
 398  0 
                 append( sb, "", 0 );
 399   
 
 400  0 
                 append( sb, "tags", 2 );
 401  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>\n\nSee Javadoc.\n", 3 );
 402  0 
                 append( sb, "", 0 );
 403   
 
 404  0 
                 append( sb, "top", 2 );
 405  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 406  0 
                 append( sb, "", 0 );
 407   
 
 408  0 
                 append( sb, "use (Default: true)", 2 );
 409  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 410  0 
                 append( sb, "", 0 );
 411   
 
 412  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 413  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 );
 414  0 
                 append( sb, "", 0 );
 415   
 
 416  0 
                 append( sb, "verbose (Default: false)", 2 );
 417  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 418  0 
                 append( sb, "", 0 );
 419   
 
 420  0 
                 append( sb, "version (Default: true)", 2 );
 421  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 422  0 
                 append( sb, "", 0 );
 423   
 
 424  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 425  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 426  0 
                 append( sb, "", 0 );
 427   
             }
 428   
         }
 429   
 
 430  0 
         if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
 431   
         {
 432  0 
             append( sb, "javadoc:help", 0 );
 433  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 );
 434  0 
             append( sb, "", 0 );
 435  0 
             if ( detail )
 436   
             {
 437  0 
                 append( sb, "Available parameters:", 1 );
 438  0 
                 append( sb, "", 0 );
 439   
 
 440  0 
                 append( sb, "detail (Default: false)", 2 );
 441  0 
                 append( sb, "If true, display all settable properties for each goal.", 3 );
 442  0 
                 append( sb, "", 0 );
 443   
 
 444  0 
                 append( sb, "goal", 2 );
 445  0 
                 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
 446  0 
                 append( sb, "", 0 );
 447   
 
 448  0 
                 append( sb, "lineLength (Default: 80)", 2 );
 449  0 
                 append( sb, "The maximum length of a display line, should be positive.", 3 );
 450  0 
                 append( sb, "", 0 );
 451   
 
 452  0 
                 append( sb, "indentSize (Default: 2)", 2 );
 453  0 
                 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
 454  0 
                 append( sb, "", 0 );
 455   
             }
 456   
         }
 457   
 
 458  0 
         if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )
 459   
         {
 460  0 
             append( sb, "javadoc:jar", 0 );
 461  0 
             append( sb, "Bundles the Javadoc documentation for main source into a jar.\nNote: the aggregate parameter is always set to false.", 1 );
 462  0 
             append( sb, "", 0 );
 463  0 
             if ( detail )
 464   
             {
 465  0 
                 append( sb, "Available parameters:", 1 );
 466  0 
                 append( sb, "", 0 );
 467   
 
 468  0 
                 append( sb, "additionalJOption", 2 );
 469  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.", 3 );
 470  0 
                 append( sb, "", 0 );
 471   
 
 472  0 
                 append( sb, "additionalparam", 2 );
 473  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 );
 474  0 
                 append( sb, "", 0 );
 475   
 
 476  0 
                 append( sb, "aggregate (Default: false)", 2 );
 477  0 
                 append( sb, "Deprecated. As of version 2.5, use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 478  0 
                 append( sb, "", 0 );
 479  0 
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 480  0 
                 append( sb, "", 0 );
 481   
 
 482  0 
                 append( sb, "archive", 2 );
 483  0 
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 484  0 
                 append( sb, "", 0 );
 485   
 
 486  0 
                 append( sb, "attach (Default: true)", 2 );
 487  0 
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 488  0 
                 append( sb, "", 0 );
 489   
 
 490  0 
                 append( sb, "author (Default: true)", 2 );
 491  0 
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 492  0 
                 append( sb, "", 0 );
 493   
 
 494  0 
                 append( sb, "bootclasspath", 2 );
 495  0 
                 append( sb, "Specifies the paths where the boot classes reside.\nSee bootclasspath.\n", 3 );
 496  0 
                 append( sb, "", 0 );
 497   
 
 498  0 
                 append( sb, "bootclasspathArtifacts", 2 );
 499  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 );
 500  0 
                 append( sb, "", 0 );
 501   
 
 502  0 
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 503  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 );
 504  0 
                 append( sb, "", 0 );
 505   
 
 506  0 
                 append( sb, "breakiterator (Default: false)", 2 );
 507  0 
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 508  0 
                 append( sb, "", 0 );
 509   
 
 510  0 
                 append( sb, "charset", 2 );
 511  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 );
 512  0 
                 append( sb, "", 0 );
 513   
 
 514  0 
                 append( sb, "debug (Default: false)", 2 );
 515  0 
                 append( sb, "Set this to \'true\' to debug Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 516  0 
                 append( sb, "", 0 );
 517   
 
 518  0 
                 append( sb, "destDir", 2 );
 519  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 520  0 
                 append( sb, "", 0 );
 521   
 
 522  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 523  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 524  0 
                 append( sb, "", 0 );
 525   
 
 526  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 527  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 528  0 
                 append( sb, "", 0 );
 529   
 
 530  0 
                 append( sb, "doclet", 2 );
 531  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 532  0 
                 append( sb, "", 0 );
 533   
 
 534  0 
                 append( sb, "docletArtifact", 2 );
 535  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 );
 536  0 
                 append( sb, "", 0 );
 537   
 
 538  0 
                 append( sb, "docletArtifacts", 2 );
 539  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 );
 540  0 
                 append( sb, "", 0 );
 541   
 
 542  0 
                 append( sb, "docletPath", 2 );
 543  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 544  0 
                 append( sb, "", 0 );
 545   
 
 546  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 547  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 548  0 
                 append( sb, "", 0 );
 549   
 
 550  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 551  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 );
 552  0 
                 append( sb, "", 0 );
 553   
 
 554  0 
                 append( sb, "excludePackageNames", 2 );
 555  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 556  0 
                 append( sb, "", 0 );
 557   
 
 558  0 
                 append( sb, "excludedocfilessubdir", 2 );
 559  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 );
 560  0 
                 append( sb, "", 0 );
 561   
 
 562  0 
                 append( sb, "extdirs", 2 );
 563  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 564  0 
                 append( sb, "", 0 );
 565   
 
 566  0 
                 append( sb, "failOnError (Default: true)", 2 );
 567  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 568  0 
                 append( sb, "", 0 );
 569   
 
 570  0 
                 append( sb, "finalName", 2 );
 571  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 );
 572  0 
                 append( sb, "", 0 );
 573   
 
 574  0 
                 append( sb, "footer", 2 );
 575  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 576  0 
                 append( sb, "", 0 );
 577   
 
 578  0 
                 append( sb, "groups", 2 );
 579  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 580  0 
                 append( sb, "", 0 );
 581   
 
 582  0 
                 append( sb, "header", 2 );
 583  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 584  0 
                 append( sb, "", 0 );
 585   
 
 586  0 
                 append( sb, "helpfile", 2 );
 587  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/>.\nSee helpfile.", 3 );
 588  0 
                 append( sb, "", 0 );
 589   
 
 590   
 
 591  0 
                 append( sb, "jarOutputDirectory", 2 );
 592  0 
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 593  0 
                 append( sb, "", 0 );
 594   
 
 595  0 
                 append( sb, "javadocDirectory", 2 );
 596  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 );
 597  0 
                 append( sb, "", 0 );
 598   
 
 599  0 
                 append( sb, "javadocExecutable", 2 );
 600  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 );
 601  0 
                 append( sb, "", 0 );
 602   
 
 603  0 
                 append( sb, "javadocVersion", 2 );
 604  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 605  0 
                 append( sb, "", 0 );
 606   
 
 607  0 
                 append( sb, "keywords (Default: false)", 2 );
 608  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 );
 609  0 
                 append( sb, "", 0 );
 610   
 
 611  0 
                 append( sb, "links", 2 );
 612  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 613  0 
                 append( sb, "", 0 );
 614   
 
 615  0 
                 append( sb, "linksource (Default: false)", 2 );
 616  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 );
 617  0 
                 append( sb, "", 0 );
 618   
 
 619  0 
                 append( sb, "localRepository", 2 );
 620  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 621  0 
                 append( sb, "", 0 );
 622   
 
 623  0 
                 append( sb, "locale", 2 );
 624  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 625  0 
                 append( sb, "", 0 );
 626   
 
 627  0 
                 append( sb, "maxmemory", 2 );
 628  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 );
 629  0 
                 append( sb, "", 0 );
 630   
 
 631  0 
                 append( sb, "minmemory", 2 );
 632  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 );
 633  0 
                 append( sb, "", 0 );
 634   
 
 635  0 
                 append( sb, "nocomment (Default: false)", 2 );
 636  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 );
 637  0 
                 append( sb, "", 0 );
 638   
 
 639  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 640  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 641  0 
                 append( sb, "", 0 );
 642   
 
 643  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 644  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 );
 645  0 
                 append( sb, "", 0 );
 646   
 
 647  0 
                 append( sb, "nohelp (Default: false)", 2 );
 648  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 );
 649  0 
                 append( sb, "", 0 );
 650   
 
 651  0 
                 append( sb, "noindex (Default: false)", 2 );
 652  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 653  0 
                 append( sb, "", 0 );
 654   
 
 655  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 656  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 657  0 
                 append( sb, "", 0 );
 658   
 
 659  0 
                 append( sb, "nooverview (Default: false)", 2 );
 660  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 );
 661  0 
                 append( sb, "", 0 );
 662   
 
 663  0 
                 append( sb, "noqualifier", 2 );
 664  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 665  0 
                 append( sb, "", 0 );
 666   
 
 667  0 
                 append( sb, "nosince (Default: false)", 2 );
 668  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 669  0 
                 append( sb, "", 0 );
 670   
 
 671  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 672  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 );
 673  0 
                 append( sb, "", 0 );
 674   
 
 675  0 
                 append( sb, "notree (Default: false)", 2 );
 676  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 677  0 
                 append( sb, "", 0 );
 678   
 
 679  0 
                 append( sb, "offlineLinks", 2 );
 680  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\nSee Javadoc.\n", 3 );
 681  0 
                 append( sb, "", 0 );
 682   
 
 683  0 
                 append( sb, "old (Default: false)", 2 );
 684  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 685  0 
                 append( sb, "", 0 );
 686   
 
 687  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 688  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 689  0 
                 append( sb, "", 0 );
 690   
 
 691  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 692  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 );
 693  0 
                 append( sb, "", 0 );
 694   
 
 695  0 
                 append( sb, "packagesheader", 2 );
 696  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 697  0 
                 append( sb, "", 0 );
 698   
 
 699  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 700  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 701  0 
                 append( sb, "", 0 );
 702  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 );
 703  0 
                 append( sb, "", 0 );
 704   
 
 705  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 706  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 707  0 
                 append( sb, "", 0 );
 708  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 );
 709  0 
                 append( sb, "", 0 );
 710   
 
 711  0 
                 append( sb, "quiet (Default: false)", 2 );
 712  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 );
 713  0 
                 append( sb, "", 0 );
 714   
 
 715  0 
                 append( sb, "remoteRepositories", 2 );
 716  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 717  0 
                 append( sb, "", 0 );
 718   
 
 719  0 
                 append( sb, "resourcesArtifacts", 2 );
 720  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 );
 721  0 
                 append( sb, "", 0 );
 722   
 
 723  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 724  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 725  0 
                 append( sb, "", 0 );
 726   
 
 727  0 
                 append( sb, "show (Default: protected)", 2 );
 728  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 );
 729  0 
                 append( sb, "", 0 );
 730   
 
 731  0 
                 append( sb, "skip (Default: false)", 2 );
 732  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 733  0 
                 append( sb, "", 0 );
 734   
 
 735  0 
                 append( sb, "source", 2 );
 736  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 );
 737  0 
                 append( sb, "", 0 );
 738   
 
 739  0 
                 append( sb, "sourcepath", 2 );
 740  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 741  0 
                 append( sb, "", 0 );
 742   
 
 743  0 
                 append( sb, "sourcetab", 2 );
 744  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 );
 745  0 
                 append( sb, "", 0 );
 746   
 
 747  0 
                 append( sb, "splitindex (Default: false)", 2 );
 748  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 );
 749  0 
                 append( sb, "", 0 );
 750   
 
 751  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 752  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 753  0 
                 append( sb, "", 0 );
 754   
 
 755  0 
                 append( sb, "stylesheetfile", 2 );
 756  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 757  0 
                 append( sb, "", 0 );
 758   
 
 759  0 
                 append( sb, "subpackages", 2 );
 760  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 );
 761  0 
                 append( sb, "", 0 );
 762   
 
 763  0 
                 append( sb, "taglet", 2 );
 764  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 );
 765  0 
                 append( sb, "", 0 );
 766   
 
 767  0 
                 append( sb, "tagletArtifact", 2 );
 768  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 );
 769  0 
                 append( sb, "", 0 );
 770   
 
 771  0 
                 append( sb, "tagletArtifacts", 2 );
 772  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 );
 773  0 
                 append( sb, "", 0 );
 774   
 
 775  0 
                 append( sb, "tagletpath", 2 );
 776  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 777  0 
                 append( sb, "", 0 );
 778   
 
 779  0 
                 append( sb, "taglets", 2 );
 780  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 );
 781  0 
                 append( sb, "", 0 );
 782   
 
 783  0 
                 append( sb, "tags", 2 );
 784  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>\n\nSee Javadoc.\n", 3 );
 785  0 
                 append( sb, "", 0 );
 786   
 
 787  0 
                 append( sb, "top", 2 );
 788  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 789  0 
                 append( sb, "", 0 );
 790   
 
 791  0 
                 append( sb, "use (Default: true)", 2 );
 792  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 793  0 
                 append( sb, "", 0 );
 794   
 
 795  0 
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 796  0 
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 797  0 
                 append( sb, "", 0 );
 798   
 
 799  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 800  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 );
 801  0 
                 append( sb, "", 0 );
 802   
 
 803  0 
                 append( sb, "verbose (Default: false)", 2 );
 804  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 805  0 
                 append( sb, "", 0 );
 806   
 
 807  0 
                 append( sb, "version (Default: true)", 2 );
 808  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 809  0 
                 append( sb, "", 0 );
 810   
 
 811  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 812  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 813  0 
                 append( sb, "", 0 );
 814   
             }
 815   
         }
 816   
 
 817  0 
         if ( goal == null || goal.length() <= 0 || "javadoc".equals( goal ) )
 818   
         {
 819  0 
             append( sb, "javadoc:javadoc", 0 );
 820  0 
             append( sb, "Generates documentation for the Java code in the project using the standard Javadoc Tool.", 1 );
 821  0 
             append( sb, "", 0 );
 822  0 
             if ( detail )
 823   
             {
 824  0 
                 append( sb, "Available parameters:", 1 );
 825  0 
                 append( sb, "", 0 );
 826   
 
 827  0 
                 append( sb, "additionalJOption", 2 );
 828  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.", 3 );
 829  0 
                 append( sb, "", 0 );
 830   
 
 831  0 
                 append( sb, "additionalparam", 2 );
 832  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 );
 833  0 
                 append( sb, "", 0 );
 834   
 
 835  0 
                 append( sb, "aggregate (Default: false)", 2 );
 836  0 
                 append( sb, "Deprecated. As of version 2.5, use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 837  0 
                 append( sb, "", 0 );
 838  0 
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 839  0 
                 append( sb, "", 0 );
 840   
 
 841  0 
                 append( sb, "author (Default: true)", 2 );
 842  0 
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 843  0 
                 append( sb, "", 0 );
 844   
 
 845  0 
                 append( sb, "bootclasspath", 2 );
 846  0 
                 append( sb, "Specifies the paths where the boot classes reside.\nSee bootclasspath.\n", 3 );
 847  0 
                 append( sb, "", 0 );
 848   
 
 849  0 
                 append( sb, "bootclasspathArtifacts", 2 );
 850  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 );
 851  0 
                 append( sb, "", 0 );
 852   
 
 853  0 
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 854  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 );
 855  0 
                 append( sb, "", 0 );
 856   
 
 857  0 
                 append( sb, "breakiterator (Default: false)", 2 );
 858  0 
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 859  0 
                 append( sb, "", 0 );
 860   
 
 861  0 
                 append( sb, "charset", 2 );
 862  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 );
 863  0 
                 append( sb, "", 0 );
 864   
 
 865  0 
                 append( sb, "debug (Default: false)", 2 );
 866  0 
                 append( sb, "Set this to \'true\' to debug Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 867  0 
                 append( sb, "", 0 );
 868   
 
 869  0 
                 append( sb, "description", 2 );
 870  0 
                 append( sb, "The description of the Javadoc report.", 3 );
 871  0 
                 append( sb, "", 0 );
 872   
 
 873  0 
                 append( sb, "destDir (Default: apidocs)", 2 );
 874  0 
                 append( sb, "The name of the destination directory.\n", 3 );
 875  0 
                 append( sb, "", 0 );
 876   
 
 877  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 878  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 879  0 
                 append( sb, "", 0 );
 880   
 
 881  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 882  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 883  0 
                 append( sb, "", 0 );
 884   
 
 885  0 
                 append( sb, "doclet", 2 );
 886  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 887  0 
                 append( sb, "", 0 );
 888   
 
 889  0 
                 append( sb, "docletArtifact", 2 );
 890  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 );
 891  0 
                 append( sb, "", 0 );
 892   
 
 893  0 
                 append( sb, "docletArtifacts", 2 );
 894  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 );
 895  0 
                 append( sb, "", 0 );
 896   
 
 897  0 
                 append( sb, "docletPath", 2 );
 898  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 899  0 
                 append( sb, "", 0 );
 900   
 
 901  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 902  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 903  0 
                 append( sb, "", 0 );
 904   
 
 905  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 906  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 );
 907  0 
                 append( sb, "", 0 );
 908   
 
 909  0 
                 append( sb, "excludePackageNames", 2 );
 910  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 911  0 
                 append( sb, "", 0 );
 912   
 
 913  0 
                 append( sb, "excludedocfilessubdir", 2 );
 914  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 );
 915  0 
                 append( sb, "", 0 );
 916   
 
 917  0 
                 append( sb, "extdirs", 2 );
 918  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 919  0 
                 append( sb, "", 0 );
 920   
 
 921  0 
                 append( sb, "failOnError (Default: true)", 2 );
 922  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 923  0 
                 append( sb, "", 0 );
 924   
 
 925  0 
                 append( sb, "footer", 2 );
 926  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 927  0 
                 append( sb, "", 0 );
 928   
 
 929  0 
                 append( sb, "groups", 2 );
 930  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 931  0 
                 append( sb, "", 0 );
 932   
 
 933  0 
                 append( sb, "header", 2 );
 934  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 935  0 
                 append( sb, "", 0 );
 936   
 
 937  0 
                 append( sb, "helpfile", 2 );
 938  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/>.\nSee helpfile.", 3 );
 939  0 
                 append( sb, "", 0 );
 940   
 
 941  0 
                 append( sb, "javadocDirectory", 2 );
 942  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 );
 943  0 
                 append( sb, "", 0 );
 944   
 
 945  0 
                 append( sb, "javadocExecutable", 2 );
 946  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 );
 947  0 
                 append( sb, "", 0 );
 948   
 
 949  0 
                 append( sb, "javadocVersion", 2 );
 950  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 951  0 
                 append( sb, "", 0 );
 952   
 
 953  0 
                 append( sb, "keywords (Default: false)", 2 );
 954  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 );
 955  0 
                 append( sb, "", 0 );
 956   
 
 957  0 
                 append( sb, "links", 2 );
 958  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 959  0 
                 append( sb, "", 0 );
 960   
 
 961  0 
                 append( sb, "linksource (Default: false)", 2 );
 962  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 );
 963  0 
                 append( sb, "", 0 );
 964   
 
 965  0 
                 append( sb, "localRepository", 2 );
 966  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 967  0 
                 append( sb, "", 0 );
 968   
 
 969  0 
                 append( sb, "locale", 2 );
 970  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 971  0 
                 append( sb, "", 0 );
 972   
 
 973  0 
                 append( sb, "maxmemory", 2 );
 974  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 );
 975  0 
                 append( sb, "", 0 );
 976   
 
 977  0 
                 append( sb, "minmemory", 2 );
 978  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 );
 979  0 
                 append( sb, "", 0 );
 980   
 
 981  0 
                 append( sb, "name", 2 );
 982  0 
                 append( sb, "The name of the Javadoc report.", 3 );
 983  0 
                 append( sb, "", 0 );
 984   
 
 985  0 
                 append( sb, "nocomment (Default: false)", 2 );
 986  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 );
 987  0 
                 append( sb, "", 0 );
 988   
 
 989  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 990  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 991  0 
                 append( sb, "", 0 );
 992   
 
 993  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 994  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 );
 995  0 
                 append( sb, "", 0 );
 996   
 
 997  0 
                 append( sb, "nohelp (Default: false)", 2 );
 998  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 );
 999  0 
                 append( sb, "", 0 );
 1000   
 
 1001  0 
                 append( sb, "noindex (Default: false)", 2 );
 1002  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1003  0 
                 append( sb, "", 0 );
 1004   
 
 1005  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 1006  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1007  0 
                 append( sb, "", 0 );
 1008   
 
 1009  0 
                 append( sb, "nooverview (Default: false)", 2 );
 1010  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 );
 1011  0 
                 append( sb, "", 0 );
 1012   
 
 1013  0 
                 append( sb, "noqualifier", 2 );
 1014  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 1015  0 
                 append( sb, "", 0 );
 1016   
 
 1017  0 
                 append( sb, "nosince (Default: false)", 2 );
 1018  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1019  0 
                 append( sb, "", 0 );
 1020   
 
 1021  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 1022  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 );
 1023  0 
                 append( sb, "", 0 );
 1024   
 
 1025  0 
                 append( sb, "notree (Default: false)", 2 );
 1026  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1027  0 
                 append( sb, "", 0 );
 1028   
 
 1029  0 
                 append( sb, "offlineLinks", 2 );
 1030  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\nSee Javadoc.\n", 3 );
 1031  0 
                 append( sb, "", 0 );
 1032   
 
 1033  0 
                 append( sb, "old (Default: false)", 2 );
 1034  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1035  0 
                 append( sb, "", 0 );
 1036   
 
 1037  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1038  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1039  0 
                 append( sb, "", 0 );
 1040   
 
 1041  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1042  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 );
 1043  0 
                 append( sb, "", 0 );
 1044   
 
 1045  0 
                 append( sb, "packagesheader", 2 );
 1046  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1047  0 
                 append( sb, "", 0 );
 1048   
 
 1049  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 1050  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1051  0 
                 append( sb, "", 0 );
 1052  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 );
 1053  0 
                 append( sb, "", 0 );
 1054   
 
 1055  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 1056  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1057  0 
                 append( sb, "", 0 );
 1058  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 );
 1059  0 
                 append( sb, "", 0 );
 1060   
 
 1061  0 
                 append( sb, "quiet (Default: false)", 2 );
 1062  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 );
 1063  0 
                 append( sb, "", 0 );
 1064   
 
 1065  0 
                 append( sb, "remoteRepositories", 2 );
 1066  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1067  0 
                 append( sb, "", 0 );
 1068   
 
 1069  0 
                 append( sb, "reportOutputDirectory", 2 );
 1070  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
 1071  0 
                 append( sb, "", 0 );
 1072   
 
 1073  0 
                 append( sb, "resourcesArtifacts", 2 );
 1074  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 );
 1075  0 
                 append( sb, "", 0 );
 1076   
 
 1077  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 1078  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1079  0 
                 append( sb, "", 0 );
 1080   
 
 1081  0 
                 append( sb, "show (Default: protected)", 2 );
 1082  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 );
 1083  0 
                 append( sb, "", 0 );
 1084   
 
 1085  0 
                 append( sb, "skip (Default: false)", 2 );
 1086  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1087  0 
                 append( sb, "", 0 );
 1088   
 
 1089  0 
                 append( sb, "source", 2 );
 1090  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 );
 1091  0 
                 append( sb, "", 0 );
 1092   
 
 1093  0 
                 append( sb, "sourcepath", 2 );
 1094  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 1095  0 
                 append( sb, "", 0 );
 1096   
 
 1097  0 
                 append( sb, "sourcetab", 2 );
 1098  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 );
 1099  0 
                 append( sb, "", 0 );
 1100   
 
 1101  0 
                 append( sb, "splitindex (Default: false)", 2 );
 1102  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 );
 1103  0 
                 append( sb, "", 0 );
 1104   
 
 1105  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 1106  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 1107  0 
                 append( sb, "", 0 );
 1108   
 
 1109  0 
                 append( sb, "stylesheetfile", 2 );
 1110  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 1111  0 
                 append( sb, "", 0 );
 1112   
 
 1113  0 
                 append( sb, "subpackages", 2 );
 1114  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 );
 1115  0 
                 append( sb, "", 0 );
 1116   
 
 1117  0 
                 append( sb, "taglet", 2 );
 1118  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 );
 1119  0 
                 append( sb, "", 0 );
 1120   
 
 1121  0 
                 append( sb, "tagletArtifact", 2 );
 1122  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 );
 1123  0 
                 append( sb, "", 0 );
 1124   
 
 1125  0 
                 append( sb, "tagletArtifacts", 2 );
 1126  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 );
 1127  0 
                 append( sb, "", 0 );
 1128   
 
 1129  0 
                 append( sb, "tagletpath", 2 );
 1130  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 1131  0 
                 append( sb, "", 0 );
 1132   
 
 1133  0 
                 append( sb, "taglets", 2 );
 1134  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 );
 1135  0 
                 append( sb, "", 0 );
 1136   
 
 1137  0 
                 append( sb, "tags", 2 );
 1138  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>\n\nSee Javadoc.\n", 3 );
 1139  0 
                 append( sb, "", 0 );
 1140   
 
 1141  0 
                 append( sb, "top", 2 );
 1142  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1143  0 
                 append( sb, "", 0 );
 1144   
 
 1145  0 
                 append( sb, "use (Default: true)", 2 );
 1146  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1147  0 
                 append( sb, "", 0 );
 1148   
 
 1149  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1150  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 );
 1151  0 
                 append( sb, "", 0 );
 1152   
 
 1153  0 
                 append( sb, "verbose (Default: false)", 2 );
 1154  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1155  0 
                 append( sb, "", 0 );
 1156   
 
 1157  0 
                 append( sb, "version (Default: true)", 2 );
 1158  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1159  0 
                 append( sb, "", 0 );
 1160   
 
 1161  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1162  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1163  0 
                 append( sb, "", 0 );
 1164   
             }
 1165   
         }
 1166   
 
 1167  0 
         if ( goal == null || goal.length() <= 0 || "test-aggregate".equals( goal ) )
 1168   
         {
 1169  0 
             append( sb, "javadoc:test-aggregate", 0 );
 1170  0 
             append( sb, "Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.", 1 );
 1171  0 
             append( sb, "", 0 );
 1172  0 
             if ( detail )
 1173   
             {
 1174  0 
                 append( sb, "Available parameters:", 1 );
 1175  0 
                 append( sb, "", 0 );
 1176   
 
 1177  0 
                 append( sb, "additionalJOption", 2 );
 1178  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.", 3 );
 1179  0 
                 append( sb, "", 0 );
 1180   
 
 1181  0 
                 append( sb, "additionalparam", 2 );
 1182  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 );
 1183  0 
                 append( sb, "", 0 );
 1184   
 
 1185  0 
                 append( sb, "aggregate (Default: false)", 2 );
 1186  0 
                 append( sb, "Deprecated. As of version 2.5, use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1187  0 
                 append( sb, "", 0 );
 1188  0 
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1189  0 
                 append( sb, "", 0 );
 1190   
 
 1191  0 
                 append( sb, "author (Default: true)", 2 );
 1192  0 
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1193  0 
                 append( sb, "", 0 );
 1194   
 
 1195  0 
                 append( sb, "bootclasspath", 2 );
 1196  0 
                 append( sb, "Specifies the paths where the boot classes reside.\nSee bootclasspath.\n", 3 );
 1197  0 
                 append( sb, "", 0 );
 1198   
 
 1199  0 
                 append( sb, "bootclasspathArtifacts", 2 );
 1200  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 );
 1201  0 
                 append( sb, "", 0 );
 1202   
 
 1203  0 
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1204  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 );
 1205  0 
                 append( sb, "", 0 );
 1206   
 
 1207  0 
                 append( sb, "breakiterator (Default: false)", 2 );
 1208  0 
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1209  0 
                 append( sb, "", 0 );
 1210   
 
 1211  0 
                 append( sb, "charset", 2 );
 1212  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 );
 1213  0 
                 append( sb, "", 0 );
 1214   
 
 1215  0 
                 append( sb, "debug (Default: false)", 2 );
 1216  0 
                 append( sb, "Set this to \'true\' to debug Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 1217  0 
                 append( sb, "", 0 );
 1218   
 
 1219  0 
                 append( sb, "description", 2 );
 1220  0 
                 append( sb, "The description of the Javadoc report.", 3 );
 1221  0 
                 append( sb, "", 0 );
 1222   
 
 1223  0 
                 append( sb, "destDir (Default: testapidocs)", 2 );
 1224  0 
                 append( sb, "The name of the destination directory.\n", 3 );
 1225  0 
                 append( sb, "", 0 );
 1226   
 
 1227  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1228  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1229  0 
                 append( sb, "", 0 );
 1230   
 
 1231  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1232  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 1233  0 
                 append( sb, "", 0 );
 1234   
 
 1235  0 
                 append( sb, "doclet", 2 );
 1236  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1237  0 
                 append( sb, "", 0 );
 1238   
 
 1239  0 
                 append( sb, "docletArtifact", 2 );
 1240  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 );
 1241  0 
                 append( sb, "", 0 );
 1242   
 
 1243  0 
                 append( sb, "docletArtifacts", 2 );
 1244  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 );
 1245  0 
                 append( sb, "", 0 );
 1246   
 
 1247  0 
                 append( sb, "docletPath", 2 );
 1248  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 1249  0 
                 append( sb, "", 0 );
 1250   
 
 1251  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1252  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1253  0 
                 append( sb, "", 0 );
 1254   
 
 1255  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1256  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 );
 1257  0 
                 append( sb, "", 0 );
 1258   
 
 1259  0 
                 append( sb, "excludePackageNames", 2 );
 1260  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 1261  0 
                 append( sb, "", 0 );
 1262   
 
 1263  0 
                 append( sb, "excludedocfilessubdir", 2 );
 1264  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 );
 1265  0 
                 append( sb, "", 0 );
 1266   
 
 1267  0 
                 append( sb, "extdirs", 2 );
 1268  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 1269  0 
                 append( sb, "", 0 );
 1270   
 
 1271  0 
                 append( sb, "failOnError (Default: true)", 2 );
 1272  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 1273  0 
                 append( sb, "", 0 );
 1274   
 
 1275  0 
                 append( sb, "footer", 2 );
 1276  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1277  0 
                 append( sb, "", 0 );
 1278   
 
 1279  0 
                 append( sb, "groups", 2 );
 1280  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 1281  0 
                 append( sb, "", 0 );
 1282   
 
 1283  0 
                 append( sb, "header", 2 );
 1284  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1285  0 
                 append( sb, "", 0 );
 1286   
 
 1287  0 
                 append( sb, "helpfile", 2 );
 1288  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/>.\nSee helpfile.", 3 );
 1289  0 
                 append( sb, "", 0 );
 1290   
 
 1291  0 
                 append( sb, "javadocDirectory", 2 );
 1292  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 );
 1293  0 
                 append( sb, "", 0 );
 1294   
 
 1295  0 
                 append( sb, "javadocExecutable", 2 );
 1296  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 );
 1297  0 
                 append( sb, "", 0 );
 1298   
 
 1299  0 
                 append( sb, "javadocVersion", 2 );
 1300  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1301  0 
                 append( sb, "", 0 );
 1302   
 
 1303  0 
                 append( sb, "keywords (Default: false)", 2 );
 1304  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 );
 1305  0 
                 append( sb, "", 0 );
 1306   
 
 1307  0 
                 append( sb, "links", 2 );
 1308  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 1309  0 
                 append( sb, "", 0 );
 1310   
 
 1311  0 
                 append( sb, "linksource (Default: false)", 2 );
 1312  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 );
 1313  0 
                 append( sb, "", 0 );
 1314   
 
 1315  0 
                 append( sb, "localRepository", 2 );
 1316  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1317  0 
                 append( sb, "", 0 );
 1318   
 
 1319  0 
                 append( sb, "locale", 2 );
 1320  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1321  0 
                 append( sb, "", 0 );
 1322   
 
 1323  0 
                 append( sb, "maxmemory", 2 );
 1324  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 );
 1325  0 
                 append( sb, "", 0 );
 1326   
 
 1327  0 
                 append( sb, "minmemory", 2 );
 1328  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 );
 1329  0 
                 append( sb, "", 0 );
 1330   
 
 1331  0 
                 append( sb, "name", 2 );
 1332  0 
                 append( sb, "The name of the Javadoc report.", 3 );
 1333  0 
                 append( sb, "", 0 );
 1334   
 
 1335  0 
                 append( sb, "nocomment (Default: false)", 2 );
 1336  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 );
 1337  0 
                 append( sb, "", 0 );
 1338   
 
 1339  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 1340  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1341  0 
                 append( sb, "", 0 );
 1342   
 
 1343  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1344  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 );
 1345  0 
                 append( sb, "", 0 );
 1346   
 
 1347  0 
                 append( sb, "nohelp (Default: false)", 2 );
 1348  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 );
 1349  0 
                 append( sb, "", 0 );
 1350   
 
 1351  0 
                 append( sb, "noindex (Default: false)", 2 );
 1352  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1353  0 
                 append( sb, "", 0 );
 1354   
 
 1355  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 1356  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1357  0 
                 append( sb, "", 0 );
 1358   
 
 1359  0 
                 append( sb, "nooverview (Default: false)", 2 );
 1360  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 );
 1361  0 
                 append( sb, "", 0 );
 1362   
 
 1363  0 
                 append( sb, "noqualifier", 2 );
 1364  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 1365  0 
                 append( sb, "", 0 );
 1366   
 
 1367  0 
                 append( sb, "nosince (Default: false)", 2 );
 1368  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1369  0 
                 append( sb, "", 0 );
 1370   
 
 1371  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 1372  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 );
 1373  0 
                 append( sb, "", 0 );
 1374   
 
 1375  0 
                 append( sb, "notree (Default: false)", 2 );
 1376  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1377  0 
                 append( sb, "", 0 );
 1378   
 
 1379  0 
                 append( sb, "offlineLinks", 2 );
 1380  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\nSee Javadoc.\n", 3 );
 1381  0 
                 append( sb, "", 0 );
 1382   
 
 1383  0 
                 append( sb, "old (Default: false)", 2 );
 1384  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1385  0 
                 append( sb, "", 0 );
 1386   
 
 1387  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 1388  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1389  0 
                 append( sb, "", 0 );
 1390   
 
 1391  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1392  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 );
 1393  0 
                 append( sb, "", 0 );
 1394   
 
 1395  0 
                 append( sb, "packagesheader", 2 );
 1396  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1397  0 
                 append( sb, "", 0 );
 1398   
 
 1399  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 1400  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1401  0 
                 append( sb, "", 0 );
 1402  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 );
 1403  0 
                 append( sb, "", 0 );
 1404   
 
 1405  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 1406  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1407  0 
                 append( sb, "", 0 );
 1408  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 );
 1409  0 
                 append( sb, "", 0 );
 1410   
 
 1411  0 
                 append( sb, "quiet (Default: false)", 2 );
 1412  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 );
 1413  0 
                 append( sb, "", 0 );
 1414   
 
 1415  0 
                 append( sb, "remoteRepositories", 2 );
 1416  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1417  0 
                 append( sb, "", 0 );
 1418   
 
 1419  0 
                 append( sb, "reportOutputDirectory", 2 );
 1420  0 
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 1421  0 
                 append( sb, "", 0 );
 1422   
 
 1423  0 
                 append( sb, "resourcesArtifacts", 2 );
 1424  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 );
 1425  0 
                 append( sb, "", 0 );
 1426   
 
 1427  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 1428  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1429  0 
                 append( sb, "", 0 );
 1430   
 
 1431  0 
                 append( sb, "show (Default: protected)", 2 );
 1432  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 );
 1433  0 
                 append( sb, "", 0 );
 1434   
 
 1435  0 
                 append( sb, "skip (Default: false)", 2 );
 1436  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1437  0 
                 append( sb, "", 0 );
 1438   
 
 1439  0 
                 append( sb, "source", 2 );
 1440  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 );
 1441  0 
                 append( sb, "", 0 );
 1442   
 
 1443  0 
                 append( sb, "sourcepath", 2 );
 1444  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 1445  0 
                 append( sb, "", 0 );
 1446   
 
 1447  0 
                 append( sb, "sourcetab", 2 );
 1448  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 );
 1449  0 
                 append( sb, "", 0 );
 1450   
 
 1451  0 
                 append( sb, "splitindex (Default: false)", 2 );
 1452  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 );
 1453  0 
                 append( sb, "", 0 );
 1454   
 
 1455  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 1456  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 1457  0 
                 append( sb, "", 0 );
 1458   
 
 1459  0 
                 append( sb, "stylesheetfile", 2 );
 1460  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 1461  0 
                 append( sb, "", 0 );
 1462   
 
 1463  0 
                 append( sb, "subpackages", 2 );
 1464  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 );
 1465  0 
                 append( sb, "", 0 );
 1466   
 
 1467  0 
                 append( sb, "taglet", 2 );
 1468  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 );
 1469  0 
                 append( sb, "", 0 );
 1470   
 
 1471  0 
                 append( sb, "tagletArtifact", 2 );
 1472  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 );
 1473  0 
                 append( sb, "", 0 );
 1474   
 
 1475  0 
                 append( sb, "tagletArtifacts", 2 );
 1476  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 );
 1477  0 
                 append( sb, "", 0 );
 1478   
 
 1479  0 
                 append( sb, "tagletpath", 2 );
 1480  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 1481  0 
                 append( sb, "", 0 );
 1482   
 
 1483  0 
                 append( sb, "taglets", 2 );
 1484  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 );
 1485  0 
                 append( sb, "", 0 );
 1486   
 
 1487  0 
                 append( sb, "tags", 2 );
 1488  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>\n\nSee Javadoc.\n", 3 );
 1489  0 
                 append( sb, "", 0 );
 1490   
 
 1491  0 
                 append( sb, "testDescription", 2 );
 1492  0 
                 append( sb, "The description of the Test Javadoc report.", 3 );
 1493  0 
                 append( sb, "", 0 );
 1494   
 
 1495  0 
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 1496  0 
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1497  0 
                 append( sb, "", 0 );
 1498   
 
 1499  0 
                 append( sb, "testJavadocDirectory", 2 );
 1500  0 
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 1501  0 
                 append( sb, "", 0 );
 1502   
 
 1503  0 
                 append( sb, "testName", 2 );
 1504  0 
                 append( sb, "The name of the Test Javadoc report.", 3 );
 1505  0 
                 append( sb, "", 0 );
 1506   
 
 1507  0 
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 1508  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 );
 1509  0 
                 append( sb, "", 0 );
 1510   
 
 1511  0 
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 1512  0 
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1513  0 
                 append( sb, "", 0 );
 1514   
 
 1515  0 
                 append( sb, "top", 2 );
 1516  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1517  0 
                 append( sb, "", 0 );
 1518   
 
 1519  0 
                 append( sb, "use (Default: true)", 2 );
 1520  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1521  0 
                 append( sb, "", 0 );
 1522   
 
 1523  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1524  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 );
 1525  0 
                 append( sb, "", 0 );
 1526   
 
 1527  0 
                 append( sb, "verbose (Default: false)", 2 );
 1528  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1529  0 
                 append( sb, "", 0 );
 1530   
 
 1531  0 
                 append( sb, "version (Default: true)", 2 );
 1532  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1533  0 
                 append( sb, "", 0 );
 1534   
 
 1535  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1536  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1537  0 
                 append( sb, "", 0 );
 1538   
             }
 1539   
         }
 1540   
 
 1541  0 
         if ( goal == null || goal.length() <= 0 || "test-jar".equals( goal ) )
 1542   
         {
 1543  0 
             append( sb, "javadoc:test-jar", 0 );
 1544  0 
             append( sb, "Bundles the Javadoc documentation for test source in a jar.\nNote: the aggregate parameter is always set to false.", 1 );
 1545  0 
             append( sb, "", 0 );
 1546  0 
             if ( detail )
 1547   
             {
 1548  0 
                 append( sb, "Available parameters:", 1 );
 1549  0 
                 append( sb, "", 0 );
 1550   
 
 1551  0 
                 append( sb, "additionalJOption", 2 );
 1552  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.", 3 );
 1553  0 
                 append( sb, "", 0 );
 1554   
 
 1555  0 
                 append( sb, "additionalparam", 2 );
 1556  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 );
 1557  0 
                 append( sb, "", 0 );
 1558   
 
 1559  0 
                 append( sb, "aggregate (Default: false)", 2 );
 1560  0 
                 append( sb, "Deprecated. As of version 2.5, use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1561  0 
                 append( sb, "", 0 );
 1562  0 
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1563  0 
                 append( sb, "", 0 );
 1564   
 
 1565  0 
                 append( sb, "archive", 2 );
 1566  0 
                 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
 1567  0 
                 append( sb, "", 0 );
 1568   
 
 1569  0 
                 append( sb, "attach (Default: true)", 2 );
 1570  0 
                 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
 1571  0 
                 append( sb, "", 0 );
 1572   
 
 1573  0 
                 append( sb, "author (Default: true)", 2 );
 1574  0 
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1575  0 
                 append( sb, "", 0 );
 1576   
 
 1577  0 
                 append( sb, "bootclasspath", 2 );
 1578  0 
                 append( sb, "Specifies the paths where the boot classes reside.\nSee bootclasspath.\n", 3 );
 1579  0 
                 append( sb, "", 0 );
 1580   
 
 1581  0 
                 append( sb, "bootclasspathArtifacts", 2 );
 1582  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 );
 1583  0 
                 append( sb, "", 0 );
 1584   
 
 1585  0 
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1586  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 );
 1587  0 
                 append( sb, "", 0 );
 1588   
 
 1589  0 
                 append( sb, "breakiterator (Default: false)", 2 );
 1590  0 
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1591  0 
                 append( sb, "", 0 );
 1592   
 
 1593  0 
                 append( sb, "charset", 2 );
 1594  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 );
 1595  0 
                 append( sb, "", 0 );
 1596   
 
 1597  0 
                 append( sb, "debug (Default: false)", 2 );
 1598  0 
                 append( sb, "Set this to \'true\' to debug Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 1599  0 
                 append( sb, "", 0 );
 1600   
 
 1601  0 
                 append( sb, "destDir", 2 );
 1602  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
 1603  0 
                 append( sb, "", 0 );
 1604   
 
 1605  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1606  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1607  0 
                 append( sb, "", 0 );
 1608   
 
 1609  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1610  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 1611  0 
                 append( sb, "", 0 );
 1612   
 
 1613  0 
                 append( sb, "doclet", 2 );
 1614  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1615  0 
                 append( sb, "", 0 );
 1616   
 
 1617  0 
                 append( sb, "docletArtifact", 2 );
 1618  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 );
 1619  0 
                 append( sb, "", 0 );
 1620   
 
 1621  0 
                 append( sb, "docletArtifacts", 2 );
 1622  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 );
 1623  0 
                 append( sb, "", 0 );
 1624   
 
 1625  0 
                 append( sb, "docletPath", 2 );
 1626  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 1627  0 
                 append( sb, "", 0 );
 1628   
 
 1629  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 1630  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1631  0 
                 append( sb, "", 0 );
 1632   
 
 1633  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 1634  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 );
 1635  0 
                 append( sb, "", 0 );
 1636   
 
 1637  0 
                 append( sb, "excludePackageNames", 2 );
 1638  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 1639  0 
                 append( sb, "", 0 );
 1640   
 
 1641  0 
                 append( sb, "excludedocfilessubdir", 2 );
 1642  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 );
 1643  0 
                 append( sb, "", 0 );
 1644   
 
 1645  0 
                 append( sb, "extdirs", 2 );
 1646  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 1647  0 
                 append( sb, "", 0 );
 1648   
 
 1649  0 
                 append( sb, "failOnError (Default: true)", 2 );
 1650  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 1651  0 
                 append( sb, "", 0 );
 1652   
 
 1653  0 
                 append( sb, "finalName", 2 );
 1654  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 );
 1655  0 
                 append( sb, "", 0 );
 1656   
 
 1657  0 
                 append( sb, "footer", 2 );
 1658  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 1659  0 
                 append( sb, "", 0 );
 1660   
 
 1661  0 
                 append( sb, "groups", 2 );
 1662  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 1663  0 
                 append( sb, "", 0 );
 1664   
 
 1665  0 
                 append( sb, "header", 2 );
 1666  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 1667  0 
                 append( sb, "", 0 );
 1668   
 
 1669  0 
                 append( sb, "helpfile", 2 );
 1670  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/>.\nSee helpfile.", 3 );
 1671  0 
                 append( sb, "", 0 );
 1672   
 
 1673   
 
 1674  0 
                 append( sb, "jarOutputDirectory", 2 );
 1675  0 
                 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
 1676  0 
                 append( sb, "", 0 );
 1677   
 
 1678  0 
                 append( sb, "javadocDirectory", 2 );
 1679  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 );
 1680  0 
                 append( sb, "", 0 );
 1681   
 
 1682  0 
                 append( sb, "javadocExecutable", 2 );
 1683  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 );
 1684  0 
                 append( sb, "", 0 );
 1685   
 
 1686  0 
                 append( sb, "javadocVersion", 2 );
 1687  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 1688  0 
                 append( sb, "", 0 );
 1689   
 
 1690  0 
                 append( sb, "keywords (Default: false)", 2 );
 1691  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 );
 1692  0 
                 append( sb, "", 0 );
 1693   
 
 1694  0 
                 append( sb, "links", 2 );
 1695  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 1696  0 
                 append( sb, "", 0 );
 1697   
 
 1698  0 
                 append( sb, "linksource (Default: false)", 2 );
 1699  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 );
 1700  0 
                 append( sb, "", 0 );
 1701   
 
 1702  0 
                 append( sb, "localRepository", 2 );
 1703  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 1704  0 
                 append( sb, "", 0 );
 1705   
 
 1706  0 
                 append( sb, "locale", 2 );
 1707  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 1708  0 
                 append( sb, "", 0 );
 1709   
 
 1710  0 
                 append( sb, "maxmemory", 2 );
 1711  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 );
 1712  0 
                 append( sb, "", 0 );
 1713   
 
 1714  0 
                 append( sb, "minmemory", 2 );
 1715  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 );
 1716  0 
                 append( sb, "", 0 );
 1717   
 
 1718  0 
                 append( sb, "nocomment (Default: false)", 2 );
 1719  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 );
 1720  0 
                 append( sb, "", 0 );
 1721   
 
 1722  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 1723  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 1724  0 
                 append( sb, "", 0 );
 1725   
 
 1726  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 1727  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 );
 1728  0 
                 append( sb, "", 0 );
 1729   
 
 1730  0 
                 append( sb, "nohelp (Default: false)", 2 );
 1731  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 );
 1732  0 
                 append( sb, "", 0 );
 1733   
 
 1734  0 
                 append( sb, "noindex (Default: false)", 2 );
 1735  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 1736  0 
                 append( sb, "", 0 );
 1737   
 
 1738  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 1739  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 1740  0 
                 append( sb, "", 0 );
 1741   
 
 1742  0 
                 append( sb, "nooverview (Default: false)", 2 );
 1743  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 );
 1744  0 
                 append( sb, "", 0 );
 1745   
 
 1746  0 
                 append( sb, "noqualifier", 2 );
 1747  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 1748  0 
                 append( sb, "", 0 );
 1749   
 
 1750  0 
                 append( sb, "nosince (Default: false)", 2 );
 1751  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 1752  0 
                 append( sb, "", 0 );
 1753   
 
 1754  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 1755  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 );
 1756  0 
                 append( sb, "", 0 );
 1757   
 
 1758  0 
                 append( sb, "notree (Default: false)", 2 );
 1759  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 1760  0 
                 append( sb, "", 0 );
 1761   
 
 1762  0 
                 append( sb, "offlineLinks", 2 );
 1763  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\nSee Javadoc.\n", 3 );
 1764  0 
                 append( sb, "", 0 );
 1765   
 
 1766  0 
                 append( sb, "old (Default: false)", 2 );
 1767  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 1768  0 
                 append( sb, "", 0 );
 1769   
 
 1770  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
 1771  0 
                 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
 1772  0 
                 append( sb, "", 0 );
 1773   
 
 1774  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 1775  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 );
 1776  0 
                 append( sb, "", 0 );
 1777   
 
 1778  0 
                 append( sb, "packagesheader", 2 );
 1779  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 1780  0 
                 append( sb, "", 0 );
 1781   
 
 1782  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 1783  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 1784  0 
                 append( sb, "", 0 );
 1785  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 );
 1786  0 
                 append( sb, "", 0 );
 1787   
 
 1788  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 1789  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 1790  0 
                 append( sb, "", 0 );
 1791  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 );
 1792  0 
                 append( sb, "", 0 );
 1793   
 
 1794  0 
                 append( sb, "quiet (Default: false)", 2 );
 1795  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 );
 1796  0 
                 append( sb, "", 0 );
 1797   
 
 1798  0 
                 append( sb, "remoteRepositories", 2 );
 1799  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 1800  0 
                 append( sb, "", 0 );
 1801   
 
 1802  0 
                 append( sb, "resourcesArtifacts", 2 );
 1803  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 );
 1804  0 
                 append( sb, "", 0 );
 1805   
 
 1806  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 1807  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 1808  0 
                 append( sb, "", 0 );
 1809   
 
 1810  0 
                 append( sb, "show (Default: protected)", 2 );
 1811  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 );
 1812  0 
                 append( sb, "", 0 );
 1813   
 
 1814  0 
                 append( sb, "skip (Default: false)", 2 );
 1815  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 1816  0 
                 append( sb, "", 0 );
 1817   
 
 1818  0 
                 append( sb, "source", 2 );
 1819  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 );
 1820  0 
                 append( sb, "", 0 );
 1821   
 
 1822  0 
                 append( sb, "sourcepath", 2 );
 1823  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 1824  0 
                 append( sb, "", 0 );
 1825   
 
 1826  0 
                 append( sb, "sourcetab", 2 );
 1827  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 );
 1828  0 
                 append( sb, "", 0 );
 1829   
 
 1830  0 
                 append( sb, "splitindex (Default: false)", 2 );
 1831  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 );
 1832  0 
                 append( sb, "", 0 );
 1833   
 
 1834  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 1835  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 1836  0 
                 append( sb, "", 0 );
 1837   
 
 1838  0 
                 append( sb, "stylesheetfile", 2 );
 1839  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 1840  0 
                 append( sb, "", 0 );
 1841   
 
 1842  0 
                 append( sb, "subpackages", 2 );
 1843  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 );
 1844  0 
                 append( sb, "", 0 );
 1845   
 
 1846  0 
                 append( sb, "taglet", 2 );
 1847  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 );
 1848  0 
                 append( sb, "", 0 );
 1849   
 
 1850  0 
                 append( sb, "tagletArtifact", 2 );
 1851  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 );
 1852  0 
                 append( sb, "", 0 );
 1853   
 
 1854  0 
                 append( sb, "tagletArtifacts", 2 );
 1855  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 );
 1856  0 
                 append( sb, "", 0 );
 1857   
 
 1858  0 
                 append( sb, "tagletpath", 2 );
 1859  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 1860  0 
                 append( sb, "", 0 );
 1861   
 
 1862  0 
                 append( sb, "taglets", 2 );
 1863  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 );
 1864  0 
                 append( sb, "", 0 );
 1865   
 
 1866  0 
                 append( sb, "tags", 2 );
 1867  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>\n\nSee Javadoc.\n", 3 );
 1868  0 
                 append( sb, "", 0 );
 1869   
 
 1870  0 
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 1871  0 
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 1872  0 
                 append( sb, "", 0 );
 1873   
 
 1874  0 
                 append( sb, "testJavadocDirectory", 2 );
 1875  0 
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 1876  0 
                 append( sb, "", 0 );
 1877   
 
 1878  0 
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 1879  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 );
 1880  0 
                 append( sb, "", 0 );
 1881   
 
 1882  0 
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 1883  0 
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1884  0 
                 append( sb, "", 0 );
 1885   
 
 1886  0 
                 append( sb, "top", 2 );
 1887  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 1888  0 
                 append( sb, "", 0 );
 1889   
 
 1890  0 
                 append( sb, "use (Default: true)", 2 );
 1891  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 1892  0 
                 append( sb, "", 0 );
 1893   
 
 1894  0 
                 append( sb, "useDefaultManifestFile (Default: false)", 2 );
 1895  0 
                 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
 1896  0 
                 append( sb, "", 0 );
 1897   
 
 1898  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 1899  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 );
 1900  0 
                 append( sb, "", 0 );
 1901   
 
 1902  0 
                 append( sb, "verbose (Default: false)", 2 );
 1903  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 1904  0 
                 append( sb, "", 0 );
 1905   
 
 1906  0 
                 append( sb, "version (Default: true)", 2 );
 1907  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 1908  0 
                 append( sb, "", 0 );
 1909   
 
 1910  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 1911  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 1912  0 
                 append( sb, "", 0 );
 1913   
             }
 1914   
         }
 1915   
 
 1916  0 
         if ( goal == null || goal.length() <= 0 || "test-javadoc".equals( goal ) )
 1917   
         {
 1918  0 
             append( sb, "javadoc:test-javadoc", 0 );
 1919  0 
             append( sb, "Generates documentation for the Java Test code in the project using the standard Javadoc Tool.", 1 );
 1920  0 
             append( sb, "", 0 );
 1921  0 
             if ( detail )
 1922   
             {
 1923  0 
                 append( sb, "Available parameters:", 1 );
 1924  0 
                 append( sb, "", 0 );
 1925   
 
 1926  0 
                 append( sb, "additionalJOption", 2 );
 1927  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.", 3 );
 1928  0 
                 append( sb, "", 0 );
 1929   
 
 1930  0 
                 append( sb, "additionalparam", 2 );
 1931  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 );
 1932  0 
                 append( sb, "", 0 );
 1933   
 
 1934  0 
                 append( sb, "aggregate (Default: false)", 2 );
 1935  0 
                 append( sb, "Deprecated. As of version 2.5, use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
 1936  0 
                 append( sb, "", 0 );
 1937  0 
                 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
 1938  0 
                 append( sb, "", 0 );
 1939   
 
 1940  0 
                 append( sb, "author (Default: true)", 2 );
 1941  0 
                 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
 1942  0 
                 append( sb, "", 0 );
 1943   
 
 1944  0 
                 append( sb, "bootclasspath", 2 );
 1945  0 
                 append( sb, "Specifies the paths where the boot classes reside.\nSee bootclasspath.\n", 3 );
 1946  0 
                 append( sb, "", 0 );
 1947   
 
 1948  0 
                 append( sb, "bootclasspathArtifacts", 2 );
 1949  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 );
 1950  0 
                 append( sb, "", 0 );
 1951   
 
 1952  0 
                 append( sb, "bottom (Default: Copyright &#169; {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
 1953  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 );
 1954  0 
                 append( sb, "", 0 );
 1955   
 
 1956  0 
                 append( sb, "breakiterator (Default: false)", 2 );
 1957  0 
                 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
 1958  0 
                 append( sb, "", 0 );
 1959   
 
 1960  0 
                 append( sb, "charset", 2 );
 1961  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 );
 1962  0 
                 append( sb, "", 0 );
 1963   
 
 1964  0 
                 append( sb, "debug (Default: false)", 2 );
 1965  0 
                 append( sb, "Set this to \'true\' to debug Javadoc plugin. With this, \'options\' and \'files\' files are provided.\n", 3 );
 1966  0 
                 append( sb, "", 0 );
 1967   
 
 1968  0 
                 append( sb, "description", 2 );
 1969  0 
                 append( sb, "The description of the Javadoc report.", 3 );
 1970  0 
                 append( sb, "", 0 );
 1971   
 
 1972  0 
                 append( sb, "destDir (Default: testapidocs)", 2 );
 1973  0 
                 append( sb, "The name of the destination directory.\n", 3 );
 1974  0 
                 append( sb, "", 0 );
 1975   
 
 1976  0 
                 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
 1977  0 
                 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
 1978  0 
                 append( sb, "", 0 );
 1979   
 
 1980  0 
                 append( sb, "docfilessubdirs (Default: false)", 2 );
 1981  0 
                 append( sb, "Enables deep copying of \'doc-files\' directories.\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
 1982  0 
                 append( sb, "", 0 );
 1983   
 
 1984  0 
                 append( sb, "doclet", 2 );
 1985  0 
                 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
 1986  0 
                 append( sb, "", 0 );
 1987   
 
 1988  0 
                 append( sb, "docletArtifact", 2 );
 1989  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 );
 1990  0 
                 append( sb, "", 0 );
 1991   
 
 1992  0 
                 append( sb, "docletArtifacts", 2 );
 1993  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 );
 1994  0 
                 append( sb, "", 0 );
 1995   
 
 1996  0 
                 append( sb, "docletPath", 2 );
 1997  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee docletpath.", 3 );
 1998  0 
                 append( sb, "", 0 );
 1999   
 
 2000  0 
                 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
 2001  0 
                 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2002  0 
                 append( sb, "", 0 );
 2003   
 
 2004  0 
                 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
 2005  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 );
 2006  0 
                 append( sb, "", 0 );
 2007   
 
 2008  0 
                 append( sb, "excludePackageNames", 2 );
 2009  0 
                 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by colons (:).\nSee exclude.\nSince Java 1.4.", 3 );
 2010  0 
                 append( sb, "", 0 );
 2011   
 
 2012  0 
                 append( sb, "excludedocfilessubdir", 2 );
 2013  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 );
 2014  0 
                 append( sb, "", 0 );
 2015   
 
 2016  0 
                 append( sb, "extdirs", 2 );
 2017  0 
                 append( sb, "Specifies the directories where extension classes reside. Separate directories in dirlist with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee extdirs.", 3 );
 2018  0 
                 append( sb, "", 0 );
 2019   
 
 2020  0 
                 append( sb, "failOnError (Default: true)", 2 );
 2021  0 
                 append( sb, "Specifies whether the build will continue even if there are errors.", 3 );
 2022  0 
                 append( sb, "", 0 );
 2023   
 
 2024  0 
                 append( sb, "footer", 2 );
 2025  0 
                 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
 2026  0 
                 append( sb, "", 0 );
 2027   
 
 2028  0 
                 append( sb, "groups", 2 );
 2029  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 (:).\nSee group.\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<packages>org.apache.core</packages>\n\u00a0\u00a0</group>\n</groups>\n\nSee Javadoc.\n", 3 );
 2030  0 
                 append( sb, "", 0 );
 2031   
 
 2032  0 
                 append( sb, "header", 2 );
 2033  0 
                 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
 2034  0 
                 append( sb, "", 0 );
 2035   
 
 2036  0 
                 append( sb, "helpfile", 2 );
 2037  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/>.\nSee helpfile.", 3 );
 2038  0 
                 append( sb, "", 0 );
 2039   
 
 2040  0 
                 append( sb, "javadocDirectory", 2 );
 2041  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 );
 2042  0 
                 append( sb, "", 0 );
 2043   
 
 2044  0 
                 append( sb, "javadocExecutable", 2 );
 2045  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 );
 2046  0 
                 append( sb, "", 0 );
 2047   
 
 2048  0 
                 append( sb, "javadocVersion", 2 );
 2049  0 
                 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
 2050  0 
                 append( sb, "", 0 );
 2051   
 
 2052  0 
                 append( sb, "keywords (Default: false)", 2 );
 2053  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 );
 2054  0 
                 append( sb, "", 0 );
 2055   
 
 2056  0 
                 append( sb, "links", 2 );
 2057  0 
                 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nSee link.", 3 );
 2058  0 
                 append( sb, "", 0 );
 2059   
 
 2060  0 
                 append( sb, "linksource (Default: false)", 2 );
 2061  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 );
 2062  0 
                 append( sb, "", 0 );
 2063   
 
 2064  0 
                 append( sb, "localRepository", 2 );
 2065  0 
                 append( sb, "The local repository where the artifacts are located.", 3 );
 2066  0 
                 append( sb, "", 0 );
 2067   
 
 2068  0 
                 append( sb, "locale", 2 );
 2069  0 
                 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
 2070  0 
                 append( sb, "", 0 );
 2071   
 
 2072  0 
                 append( sb, "maxmemory", 2 );
 2073  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 );
 2074  0 
                 append( sb, "", 0 );
 2075   
 
 2076  0 
                 append( sb, "minmemory", 2 );
 2077  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 );
 2078  0 
                 append( sb, "", 0 );
 2079   
 
 2080  0 
                 append( sb, "name", 2 );
 2081  0 
                 append( sb, "The name of the Javadoc report.", 3 );
 2082  0 
                 append( sb, "", 0 );
 2083   
 
 2084  0 
                 append( sb, "nocomment (Default: false)", 2 );
 2085  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 );
 2086  0 
                 append( sb, "", 0 );
 2087   
 
 2088  0 
                 append( sb, "nodeprecated (Default: false)", 2 );
 2089  0 
                 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
 2090  0 
                 append( sb, "", 0 );
 2091   
 
 2092  0 
                 append( sb, "nodeprecatedlist (Default: false)", 2 );
 2093  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 );
 2094  0 
                 append( sb, "", 0 );
 2095   
 
 2096  0 
                 append( sb, "nohelp (Default: false)", 2 );
 2097  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 );
 2098  0 
                 append( sb, "", 0 );
 2099   
 
 2100  0 
                 append( sb, "noindex (Default: false)", 2 );
 2101  0 
                 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
 2102  0 
                 append( sb, "", 0 );
 2103   
 
 2104  0 
                 append( sb, "nonavbar (Default: false)", 2 );
 2105  0 
                 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
 2106  0 
                 append( sb, "", 0 );
 2107   
 
 2108  0 
                 append( sb, "nooverview (Default: false)", 2 );
 2109  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 );
 2110  0 
                 append( sb, "", 0 );
 2111   
 
 2112  0 
                 append( sb, "noqualifier", 2 );
 2113  0 
                 append( sb, "Omits qualifying package name from ahead of class names in output.\nSee noqualifier.\nSince Java 1.4.", 3 );
 2114  0 
                 append( sb, "", 0 );
 2115   
 
 2116  0 
                 append( sb, "nosince (Default: false)", 2 );
 2117  0 
                 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
 2118  0 
                 append( sb, "", 0 );
 2119   
 
 2120  0 
                 append( sb, "notimestamp (Default: false)", 2 );
 2121  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 );
 2122  0 
                 append( sb, "", 0 );
 2123   
 
 2124  0 
                 append( sb, "notree (Default: false)", 2 );
 2125  0 
                 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
 2126  0 
                 append( sb, "", 0 );
 2127   
 
 2128  0 
                 append( sb, "offlineLinks", 2 );
 2129  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\nSee Javadoc.\n", 3 );
 2130  0 
                 append( sb, "", 0 );
 2131   
 
 2132  0 
                 append( sb, "old (Default: false)", 2 );
 2133  0 
                 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
 2134  0 
                 append( sb, "", 0 );
 2135   
 
 2136  0 
                 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
 2137  0 
                 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
 2138  0 
                 append( sb, "", 0 );
 2139   
 
 2140  0 
                 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
 2141  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 );
 2142  0 
                 append( sb, "", 0 );
 2143   
 
 2144  0 
                 append( sb, "packagesheader", 2 );
 2145  0 
                 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
 2146  0 
                 append( sb, "", 0 );
 2147   
 
 2148  0 
                 append( sb, "proxyHost (Default: ${settings.activeProxy.host})", 2 );
 2149  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
 2150  0 
                 append( sb, "", 0 );
 2151  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 );
 2152  0 
                 append( sb, "", 0 );
 2153   
 
 2154  0 
                 append( sb, "proxyPort (Default: ${settings.activeProxy.port})", 2 );
 2155  0 
                 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
 2156  0 
                 append( sb, "", 0 );
 2157  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 );
 2158  0 
                 append( sb, "", 0 );
 2159   
 
 2160  0 
                 append( sb, "quiet (Default: false)", 2 );
 2161  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 );
 2162  0 
                 append( sb, "", 0 );
 2163   
 
 2164  0 
                 append( sb, "remoteRepositories", 2 );
 2165  0 
                 append( sb, "The remote repositories where artifacts are located.", 3 );
 2166  0 
                 append( sb, "", 0 );
 2167   
 
 2168  0 
                 append( sb, "reportOutputDirectory", 2 );
 2169  0 
                 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
 2170  0 
                 append( sb, "", 0 );
 2171   
 
 2172  0 
                 append( sb, "resourcesArtifacts", 2 );
 2173  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 );
 2174  0 
                 append( sb, "", 0 );
 2175   
 
 2176  0 
                 append( sb, "serialwarn (Default: false)", 2 );
 2177  0 
                 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
 2178  0 
                 append( sb, "", 0 );
 2179   
 
 2180  0 
                 append( sb, "show (Default: protected)", 2 );
 2181  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 );
 2182  0 
                 append( sb, "", 0 );
 2183   
 
 2184  0 
                 append( sb, "skip (Default: false)", 2 );
 2185  0 
                 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
 2186  0 
                 append( sb, "", 0 );
 2187   
 
 2188  0 
                 append( sb, "source", 2 );
 2189  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 );
 2190  0 
                 append( sb, "", 0 );
 2191   
 
 2192  0 
                 append( sb, "sourcepath", 2 );
 2193  0 
                 append( sb, "Specifies the source paths where the subpackages are located. The paths are separated with a colon (:) on Solaris and a semi-colon (;) on Windows.\nSee sourcepath.", 3 );
 2194  0 
                 append( sb, "", 0 );
 2195   
 
 2196  0 
                 append( sb, "sourcetab", 2 );
 2197  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 );
 2198  0 
                 append( sb, "", 0 );
 2199   
 
 2200  0 
                 append( sb, "splitindex (Default: false)", 2 );
 2201  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 );
 2202  0 
                 append( sb, "", 0 );
 2203   
 
 2204  0 
                 append( sb, "stylesheet (Default: java)", 2 );
 2205  0 
                 append( sb, "Specifies whether the stylesheet to be used is the maven javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified. Possible values: \'maven\' or \'java\'.\n", 3 );
 2206  0 
                 append( sb, "", 0 );
 2207   
 
 2208  0 
                 append( sb, "stylesheetfile", 2 );
 2209  0 
                 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nSee stylesheetfile.", 3 );
 2210  0 
                 append( sb, "", 0 );
 2211   
 
 2212  0 
                 append( sb, "subpackages", 2 );
 2213  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 );
 2214  0 
                 append( sb, "", 0 );
 2215   
 
 2216  0 
                 append( sb, "taglet", 2 );
 2217  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 );
 2218  0 
                 append( sb, "", 0 );
 2219   
 
 2220  0 
                 append( sb, "tagletArtifact", 2 );
 2221  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 );
 2222  0 
                 append( sb, "", 0 );
 2223   
 
 2224  0 
                 append( sb, "tagletArtifacts", 2 );
 2225  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 );
 2226  0 
                 append( sb, "", 0 );
 2227   
 
 2228  0 
                 append( sb, "tagletpath", 2 );
 2229  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 (:) on Solaris and a semi-colon (;) on Windows.\nSee tagletpath.\nSince Java 1.4.", 3 );
 2230  0 
                 append( sb, "", 0 );
 2231   
 
 2232  0 
                 append( sb, "taglets", 2 );
 2233  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 );
 2234  0 
                 append( sb, "", 0 );
 2235   
 
 2236  0 
                 append( sb, "tags", 2 );
 2237  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>\n\nSee Javadoc.\n", 3 );
 2238  0 
                 append( sb, "", 0 );
 2239   
 
 2240  0 
                 append( sb, "testDescription", 2 );
 2241  0 
                 append( sb, "The description of the Test Javadoc report.", 3 );
 2242  0 
                 append( sb, "", 0 );
 2243   
 
 2244  0 
                 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2245  0 
                 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
 2246  0 
                 append( sb, "", 0 );
 2247   
 
 2248  0 
                 append( sb, "testJavadocDirectory", 2 );
 2249  0 
                 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
 2250  0 
                 append( sb, "", 0 );
 2251   
 
 2252  0 
                 append( sb, "testName", 2 );
 2253  0 
                 append( sb, "The name of the Test Javadoc report.", 3 );
 2254  0 
                 append( sb, "", 0 );
 2255   
 
 2256  0 
                 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
 2257  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 );
 2258  0 
                 append( sb, "", 0 );
 2259   
 
 2260  0 
                 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
 2261  0 
                 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2262  0 
                 append( sb, "", 0 );
 2263   
 
 2264  0 
                 append( sb, "top", 2 );
 2265  0 
                 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
 2266  0 
                 append( sb, "", 0 );
 2267   
 
 2268  0 
                 append( sb, "use (Default: true)", 2 );
 2269  0 
                 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
 2270  0 
                 append( sb, "", 0 );
 2271   
 
 2272  0 
                 append( sb, "useStandardDocletOptions (Default: true)", 2 );
 2273  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 );
 2274  0 
                 append( sb, "", 0 );
 2275   
 
 2276  0 
                 append( sb, "verbose (Default: false)", 2 );
 2277  0 
                 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
 2278  0 
                 append( sb, "", 0 );
 2279   
 
 2280  0 
                 append( sb, "version (Default: true)", 2 );
 2281  0 
                 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
 2282  0 
                 append( sb, "", 0 );
 2283   
 
 2284  0 
                 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
 2285  0 
                 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
 2286  0 
                 append( sb, "", 0 );
 2287   
             }
 2288   
         }
 2289   
 
 2290  0 
         if ( getLog().isInfoEnabled() )
 2291   
         {
 2292  0 
             getLog().info( sb.toString() );
 2293   
         }
 2294  0 
     }
 2295   
 
 2296   
     /**
 2297   
      * <p>Repeat a String <code>n</code> times to form a new string.</p>
 2298   
      *
 2299   
      * @param str String to repeat
 2300   
      * @param repeat number of times to repeat str
 2301   
      * @return String with repeated String
 2302   
      * @throws NegativeArraySizeException if <code>repeat < 0</code>
 2303   
      * @throws NullPointerException if str is <code>null</code>
 2304   
      */
 2305   
     private static String repeat( String str, int repeat )
 2306   
     {
 2307  0 
         StringBuffer buffer = new StringBuffer( repeat * str.length() );
 2308   
 
 2309  0 
         for ( int i = 0; i < repeat; i++ )
 2310   
         {
 2311  0 
             buffer.append( str );
 2312   
         }
 2313   
 
 2314  0 
         return buffer.toString();
 2315   
     }
 2316   
 
 2317   
     /**
 2318   
      * Append a description to the buffer by respecting the indentSize and lineLength parameters.
 2319   
      * <b>Note</b>: The last character is always a new line.
 2320   
      *
 2321   
      * @param sb The buffer to append the description, not <code>null</code>.
 2322   
      * @param description The description, not <code>null</code>.
 2323   
      * @param indent The base indentation level of each line, must not be negative.
 2324   
      */
 2325   
     private void append( StringBuffer sb, String description, int indent )
 2326   
     {
 2327  0 
         for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
 2328   
         {
 2329  0 
             sb.append( it.next().toString() ).append( '\n' );
 2330   
         }
 2331  0 
     }
 2332   
 
 2333   
     /**
 2334   
      * Splits the specified text into lines of convenient display length.
 2335   
      *
 2336   
      * @param text The text to split into lines, must not be <code>null</code>.
 2337   
      * @param indent The base indentation level of each line, must not be negative.
 2338   
      * @param indentSize The size of each indentation, must not be negative.
 2339   
      * @param lineLength The length of the line, must not be negative.
 2340   
      * @return The sequence of display lines, never <code>null</code>.
 2341   
      * @throws NegativeArraySizeException if <code>indent < 0</code>
 2342   
      */
 2343   
     private static List toLines( String text, int indent, int indentSize, int lineLength )
 2344   
     {
 2345  0 
         List lines = new ArrayList();
 2346   
 
 2347  0 
         String ind = repeat( "\t", indent );
 2348  0 
         String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
 2349  0 
         for ( int i = 0; i < plainLines.length; i++ )
 2350   
         {
 2351  0 
             toLines( lines, ind + plainLines[i], indentSize, lineLength );
 2352   
         }
 2353   
 
 2354  0 
         return lines;
 2355   
     }
 2356   
 
 2357   
     /**
 2358   
      * Adds the specified line to the output sequence, performing line wrapping if necessary.
 2359   
      *
 2360   
      * @param lines The sequence of display lines, must not be <code>null</code>.
 2361   
      * @param line The line to add, must not be <code>null</code>.
 2362   
      * @param indentSize The size of each indentation, must not be negative.
 2363   
      * @param lineLength The length of the line, must not be negative.
 2364   
      */
 2365   
     private static void toLines( List lines, String line, int indentSize, int lineLength )
 2366   
     {
 2367  0 
         int lineIndent = getIndentLevel( line );
 2368  0 
         StringBuffer buf = new StringBuffer( 256 );
 2369  0 
         String[] tokens = line.split( " +" );
 2370  0 
         for ( int i = 0; i < tokens.length; i++ )
 2371   
         {
 2372  0 
             String token = tokens[i];
 2373  0 
             if ( i > 0 )
 2374   
             {
 2375  0 
                 if ( buf.length() + token.length() >= lineLength )
 2376   
                 {
 2377  0 
                     lines.add( buf.toString() );
 2378  0 
                     buf.setLength( 0 );
 2379  0 
                     buf.append( repeat( " ", lineIndent * indentSize ) );
 2380   
                 }
 2381   
                 else
 2382   
                 {
 2383  0 
                     buf.append( ' ' );
 2384   
                 }
 2385   
             }
 2386  0 
             for ( int j = 0; j < token.length(); j++ )
 2387   
             {
 2388  0 
                 char c = token.charAt( j );
 2389  0 
                 if ( c == '\t' )
 2390   
                 {
 2391  0 
                     buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
 2392   
                 }
 2393  0 
                 else if ( c == '\u00A0' )
 2394   
                 {
 2395  0 
                     buf.append( ' ' );
 2396   
                 }
 2397   
                 else
 2398   
                 {
 2399  0 
                     buf.append( c );
 2400   
                 }
 2401   
             }
 2402   
         }
 2403  0 
         lines.add( buf.toString() );
 2404  0 
     }
 2405   
 
 2406   
     /**
 2407   
      * Gets the indentation level of the specified line.
 2408   
      *
 2409   
      * @param line The line whose indentation level should be retrieved, must not be <code>null</code>.
 2410   
      * @return The indentation level of the line.
 2411   
      */
 2412   
     private static int getIndentLevel( String line )
 2413   
     {
 2414  0 
         int level = 0;
 2415  0 
         for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
 2416   
         {
 2417  0 
             level++;
 2418   
         }
 2419  0 
         for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
 2420   
         {
 2421  0 
             if ( line.charAt( i ) == '\t' )
 2422   
             {
 2423  0 
                 level++;
 2424  0 
                 break;
 2425   
             }
 2426   
         }
 2427  0 
         return level;
 2428   
     }
 2429   
 }
Report generated by Cobertura 1.9 on 08-08-22 07:34.