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
12
13
14
15
16
17
18
19 @SuppressWarnings( "all" )
20 public class HelpMojo
21 extends AbstractMojo
22 {
23
24
25
26
27
28 private boolean detail;
29
30
31
32
33
34
35 private java.lang.String goal;
36
37
38
39
40
41
42 private int lineLength;
43
44
45
46
47
48
49 private int indentSize;
50
51
52
53 public void execute()
54 throws MojoExecutionException
55 {
56 if ( lineLength <= 0 )
57 {
58 getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
59 lineLength = 80;
60 }
61 if ( indentSize <= 0 )
62 {
63 getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
64 indentSize = 2;
65 }
66
67 StringBuffer sb = new StringBuffer();
68
69 append( sb, "org.apache.maven.plugins:maven-javadoc-plugin:2.8.1", 0 );
70 append( sb, "", 0 );
71
72 append( sb, "Maven Javadoc Plugin", 0 );
73 append( sb, "The Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.", 1 );
74 append( sb, "", 0 );
75
76 if ( goal == null || goal.length() <= 0 )
77 {
78 append( sb, "This plugin has 13 goals:", 0 );
79 append( sb, "", 0 );
80 }
81
82 if ( goal == null || goal.length() <= 0 || "aggregate".equals( goal ) )
83 {
84 append( sb, "javadoc:aggregate", 0 );
85 append( sb, "Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.", 1 );
86 append( sb, "", 0 );
87 if ( detail )
88 {
89 append( sb, "Available parameters:", 1 );
90 append( sb, "", 0 );
91
92 append( sb, "additionalJOption", 2 );
93 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
94 append( sb, "Expression: ${additionalJOption}", 3 );
95 append( sb, "", 0 );
96
97 append( sb, "additionalparam", 2 );
98 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 );
99 append( sb, "Expression: ${additionalparam}", 3 );
100 append( sb, "", 0 );
101
102 append( sb, "additionnalDependencies", 2 );
103 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
104 append( sb, "", 0 );
105
106 append( sb, "aggregate (Default: false)", 2 );
107 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
108 append( sb, "", 0 );
109 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
110 append( sb, "Expression: ${aggregate}", 3 );
111 append( sb, "", 0 );
112
113 append( sb, "author (Default: true)", 2 );
114 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
115 append( sb, "Expression: ${author}", 3 );
116 append( sb, "", 0 );
117
118 append( sb, "bootclasspath", 2 );
119 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
120 append( sb, "Expression: ${bootclasspath}", 3 );
121 append( sb, "", 0 );
122
123 append( sb, "bootclasspathArtifacts", 2 );
124 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 );
125 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
126 append( sb, "", 0 );
127
128 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
129 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 );
130 append( sb, "Expression: ${bottom}", 3 );
131 append( sb, "", 0 );
132
133 append( sb, "breakiterator (Default: false)", 2 );
134 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
135 append( sb, "Expression: ${breakiterator}", 3 );
136 append( sb, "", 0 );
137
138 append( sb, "charset", 2 );
139 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 );
140 append( sb, "Expression: ${charset}", 3 );
141 append( sb, "", 0 );
142
143 append( sb, "debug (Default: false)", 2 );
144 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
145 append( sb, "Expression: ${debug}", 3 );
146 append( sb, "", 0 );
147
148 append( sb, "dependencySourceExcludes", 2 );
149 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
150 append( sb, "", 0 );
151
152 append( sb, "dependencySourceIncludes", 2 );
153 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
154 append( sb, "", 0 );
155
156 append( sb, "description", 2 );
157 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
158 append( sb, "Expression: ${description}", 3 );
159 append( sb, "", 0 );
160
161 append( sb, "destDir (Default: apidocs)", 2 );
162 append( sb, "The name of the destination directory.\n", 3 );
163 append( sb, "Expression: ${destDir}", 3 );
164 append( sb, "", 0 );
165
166 append( sb, "detectJavaApiLink (Default: true)", 2 );
167 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
168 append( sb, "Expression: ${detectJavaApiLink}", 3 );
169 append( sb, "", 0 );
170
171 append( sb, "detectLinks (Default: false)", 2 );
172 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
173 append( sb, "Expression: ${detectLinks}", 3 );
174 append( sb, "", 0 );
175
176 append( sb, "detectOfflineLinks (Default: true)", 2 );
177 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
178 append( sb, "Expression: ${detectOfflineLinks}", 3 );
179 append( sb, "", 0 );
180
181 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
182 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
183 append( sb, "Expression: ${docencoding}", 3 );
184 append( sb, "", 0 );
185
186 append( sb, "docfilessubdirs (Default: false)", 2 );
187 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
188 append( sb, "Expression: ${docfilessubdirs}", 3 );
189 append( sb, "", 0 );
190
191 append( sb, "doclet", 2 );
192 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
193 append( sb, "Expression: ${doclet}", 3 );
194 append( sb, "", 0 );
195
196 append( sb, "docletArtifact", 2 );
197 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 );
198 append( sb, "Expression: ${docletArtifact}", 3 );
199 append( sb, "", 0 );
200
201 append( sb, "docletArtifacts", 2 );
202 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 );
203 append( sb, "Expression: ${docletArtifacts}", 3 );
204 append( sb, "", 0 );
205
206 append( sb, "docletPath", 2 );
207 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
208 append( sb, "Expression: ${docletPath}", 3 );
209 append( sb, "", 0 );
210
211 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
212 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
213 append( sb, "Expression: ${doctitle}", 3 );
214 append( sb, "", 0 );
215
216 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
217 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 );
218 append( sb, "Expression: ${encoding}", 3 );
219 append( sb, "", 0 );
220
221 append( sb, "excludedocfilessubdir", 2 );
222 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 );
223 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
224 append( sb, "", 0 );
225
226 append( sb, "excludePackageNames", 2 );
227 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
228 append( sb, "Expression: ${excludePackageNames}", 3 );
229 append( sb, "", 0 );
230
231 append( sb, "extdirs", 2 );
232 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
233 append( sb, "Expression: ${extdirs}", 3 );
234 append( sb, "", 0 );
235
236 append( sb, "failOnError (Default: true)", 2 );
237 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
238 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
239 append( sb, "", 0 );
240
241 append( sb, "footer", 2 );
242 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
243 append( sb, "Expression: ${footer}", 3 );
244 append( sb, "", 0 );
245
246 append( sb, "groups", 2 );
247 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
248 append( sb, "Expression: ${groups}", 3 );
249 append( sb, "", 0 );
250
251 append( sb, "header", 2 );
252 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
253 append( sb, "Expression: ${header}", 3 );
254 append( sb, "", 0 );
255
256 append( sb, "helpfile", 2 );
257 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
258 append( sb, "Expression: ${helpfile}", 3 );
259 append( sb, "", 0 );
260
261 append( sb, "includeDependencySources (Default: false)", 2 );
262 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
263 append( sb, "", 0 );
264
265 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
266 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
267 append( sb, "", 0 );
268
269 append( sb, "javaApiLinks", 2 );
270 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
271 append( sb, "Expression: ${javaApiLinks}", 3 );
272 append( sb, "", 0 );
273
274 append( sb, "javadocDirectory", 2 );
275 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 );
276 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
277 append( sb, "", 0 );
278
279 append( sb, "javadocExecutable", 2 );
280 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 );
281 append( sb, "Expression: ${javadocExecutable}", 3 );
282 append( sb, "", 0 );
283
284 append( sb, "javadocVersion", 2 );
285 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
286 append( sb, "Expression: ${javadocVersion}", 3 );
287 append( sb, "", 0 );
288
289 append( sb, "keywords (Default: false)", 2 );
290 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 );
291 append( sb, "Expression: ${keywords}", 3 );
292 append( sb, "", 0 );
293
294 append( sb, "links", 2 );
295 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
296 append( sb, "Expression: ${links}", 3 );
297 append( sb, "", 0 );
298
299 append( sb, "linksource (Default: false)", 2 );
300 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 );
301 append( sb, "Expression: ${linksource}", 3 );
302 append( sb, "", 0 );
303
304 append( sb, "locale", 2 );
305 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
306 append( sb, "Expression: ${locale}", 3 );
307 append( sb, "", 0 );
308
309 append( sb, "localRepository", 2 );
310 append( sb, "The local repository where the artifacts are located.", 3 );
311 append( sb, "Expression: ${localRepository}", 3 );
312 append( sb, "", 0 );
313
314 append( sb, "maxmemory", 2 );
315 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 );
316 append( sb, "Expression: ${maxmemory}", 3 );
317 append( sb, "", 0 );
318
319 append( sb, "minmemory", 2 );
320 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 );
321 append( sb, "Expression: ${minmemory}", 3 );
322 append( sb, "", 0 );
323
324 append( sb, "name", 2 );
325 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
326 append( sb, "Expression: ${name}", 3 );
327 append( sb, "", 0 );
328
329 append( sb, "nocomment (Default: false)", 2 );
330 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 );
331 append( sb, "Expression: ${nocomment}", 3 );
332 append( sb, "", 0 );
333
334 append( sb, "nodeprecated (Default: false)", 2 );
335 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
336 append( sb, "Expression: ${nodeprecated}", 3 );
337 append( sb, "", 0 );
338
339 append( sb, "nodeprecatedlist (Default: false)", 2 );
340 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 );
341 append( sb, "Expression: ${nodeprecatedlist}", 3 );
342 append( sb, "", 0 );
343
344 append( sb, "nohelp (Default: false)", 2 );
345 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 );
346 append( sb, "Expression: ${nohelp}", 3 );
347 append( sb, "", 0 );
348
349 append( sb, "noindex (Default: false)", 2 );
350 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
351 append( sb, "Expression: ${noindex}", 3 );
352 append( sb, "", 0 );
353
354 append( sb, "nonavbar (Default: false)", 2 );
355 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
356 append( sb, "Expression: ${nonavbar}", 3 );
357 append( sb, "", 0 );
358
359 append( sb, "nooverview (Default: false)", 2 );
360 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
361 append( sb, "Expression: ${nooverview}", 3 );
362 append( sb, "", 0 );
363
364 append( sb, "noqualifier", 2 );
365 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
366 append( sb, "Expression: ${noqualifier}", 3 );
367 append( sb, "", 0 );
368
369 append( sb, "nosince (Default: false)", 2 );
370 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
371 append( sb, "Expression: ${nosince}", 3 );
372 append( sb, "", 0 );
373
374 append( sb, "notimestamp (Default: false)", 2 );
375 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 );
376 append( sb, "Expression: ${notimestamp}", 3 );
377 append( sb, "", 0 );
378
379 append( sb, "notree (Default: false)", 2 );
380 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
381 append( sb, "Expression: ${notree}", 3 );
382 append( sb, "", 0 );
383
384 append( sb, "offlineLinks", 2 );
385 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
386 append( sb, "Expression: ${offlineLinks}", 3 );
387 append( sb, "", 0 );
388
389 append( sb, "old (Default: false)", 2 );
390 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
391 append( sb, "Expression: ${old}", 3 );
392 append( sb, "", 0 );
393
394 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
395 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
396 append( sb, "Required: Yes", 3 );
397 append( sb, "Expression: ${destDir}", 3 );
398 append( sb, "", 0 );
399
400 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
401 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 );
402 append( sb, "Expression: ${overview}", 3 );
403 append( sb, "", 0 );
404
405 append( sb, "packagesheader", 2 );
406 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
407 append( sb, "Expression: ${packagesheader}", 3 );
408 append( sb, "", 0 );
409
410 append( sb, "proxyHost", 2 );
411 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
412 append( sb, "", 0 );
413 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 );
414 append( sb, "Expression: ${proxyHost}", 3 );
415 append( sb, "", 0 );
416
417 append( sb, "proxyPort", 2 );
418 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
419 append( sb, "", 0 );
420 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 );
421 append( sb, "Expression: ${proxyPort}", 3 );
422 append( sb, "", 0 );
423
424 append( sb, "quiet (Default: false)", 2 );
425 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 );
426 append( sb, "Expression: ${quiet}", 3 );
427 append( sb, "", 0 );
428
429 append( sb, "remoteRepositories", 2 );
430 append( sb, "The remote repositories where artifacts are located.", 3 );
431 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
432 append( sb, "", 0 );
433
434 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
435 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
436 append( sb, "Required: Yes", 3 );
437 append( sb, "Expression: ${reportOutputDirectory}", 3 );
438 append( sb, "", 0 );
439
440 append( sb, "resourcesArtifacts", 2 );
441 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 );
442 append( sb, "Expression: ${resourcesArtifacts}", 3 );
443 append( sb, "", 0 );
444
445 append( sb, "serialwarn (Default: false)", 2 );
446 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
447 append( sb, "Expression: ${serialwarn}", 3 );
448 append( sb, "", 0 );
449
450 append( sb, "show (Default: protected)", 2 );
451 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 );
452 append( sb, "Expression: ${show}", 3 );
453 append( sb, "", 0 );
454
455 append( sb, "skip (Default: false)", 2 );
456 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
457 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
458 append( sb, "", 0 );
459
460 append( sb, "source", 2 );
461 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
462 append( sb, "Expression: ${source}", 3 );
463 append( sb, "", 0 );
464
465 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
466 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
467 append( sb, "", 0 );
468
469 append( sb, "sourcepath", 2 );
470 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
471 append( sb, "Expression: ${sourcepath}", 3 );
472 append( sb, "", 0 );
473
474 append( sb, "sourcetab", 2 );
475 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 );
476 append( sb, "Expression: ${sourcetab}", 3 );
477 append( sb, "", 0 );
478
479 append( sb, "splitindex (Default: false)", 2 );
480 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 );
481 append( sb, "Expression: ${splitindex}", 3 );
482 append( sb, "", 0 );
483
484 append( sb, "stylesheet (Default: java)", 2 );
485 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
486 append( sb, "Expression: ${stylesheet}", 3 );
487 append( sb, "", 0 );
488
489 append( sb, "stylesheetfile", 2 );
490 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
491 append( sb, "Expression: ${stylesheetfile}", 3 );
492 append( sb, "", 0 );
493
494 append( sb, "subpackages", 2 );
495 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 );
496 append( sb, "Expression: ${subpackages}", 3 );
497 append( sb, "", 0 );
498
499 append( sb, "taglet", 2 );
500 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 );
501 append( sb, "Expression: ${taglet}", 3 );
502 append( sb, "", 0 );
503
504 append( sb, "tagletArtifact", 2 );
505 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 );
506 append( sb, "Expression: ${tagletArtifact}", 3 );
507 append( sb, "", 0 );
508
509 append( sb, "tagletArtifacts", 2 );
510 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 );
511 append( sb, "Expression: ${tagletArtifacts}", 3 );
512 append( sb, "", 0 );
513
514 append( sb, "tagletpath", 2 );
515 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
516 append( sb, "Expression: ${tagletpath}", 3 );
517 append( sb, "", 0 );
518
519 append( sb, "taglets", 2 );
520 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 );
521 append( sb, "Expression: ${taglets}", 3 );
522 append( sb, "", 0 );
523
524 append( sb, "tags", 2 );
525 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
526 append( sb, "Expression: ${tags}", 3 );
527 append( sb, "", 0 );
528
529 append( sb, "top", 2 );
530 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
531 append( sb, "Expression: ${top}", 3 );
532 append( sb, "", 0 );
533
534 append( sb, "use (Default: true)", 2 );
535 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
536 append( sb, "Expression: ${use}", 3 );
537 append( sb, "", 0 );
538
539 append( sb, "useStandardDocletOptions (Default: true)", 2 );
540 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 );
541 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
542 append( sb, "", 0 );
543
544 append( sb, "validateLinks (Default: false)", 2 );
545 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
546 append( sb, "Expression: ${validateLinks}", 3 );
547 append( sb, "", 0 );
548
549 append( sb, "verbose (Default: false)", 2 );
550 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
551 append( sb, "Expression: ${verbose}", 3 );
552 append( sb, "", 0 );
553
554 append( sb, "version (Default: true)", 2 );
555 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
556 append( sb, "Expression: ${version}", 3 );
557 append( sb, "", 0 );
558
559 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
560 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
561 append( sb, "Expression: ${windowtitle}", 3 );
562 append( sb, "", 0 );
563 }
564 }
565
566 if ( goal == null || goal.length() <= 0 || "aggregate-jar".equals( goal ) )
567 {
568 append( sb, "javadoc:aggregate-jar", 0 );
569 append( sb, "Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
570 append( sb, "", 0 );
571 if ( detail )
572 {
573 append( sb, "Available parameters:", 1 );
574 append( sb, "", 0 );
575
576 append( sb, "additionalJOption", 2 );
577 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
578 append( sb, "Expression: ${additionalJOption}", 3 );
579 append( sb, "", 0 );
580
581 append( sb, "additionalparam", 2 );
582 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 );
583 append( sb, "Expression: ${additionalparam}", 3 );
584 append( sb, "", 0 );
585
586 append( sb, "additionnalDependencies", 2 );
587 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
588 append( sb, "", 0 );
589
590 append( sb, "aggregate (Default: false)", 2 );
591 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
592 append( sb, "", 0 );
593 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
594 append( sb, "Expression: ${aggregate}", 3 );
595 append( sb, "", 0 );
596
597 append( sb, "archive", 2 );
598 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
599 append( sb, "", 0 );
600
601 append( sb, "attach (Default: true)", 2 );
602 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
603 append( sb, "Expression: ${attach}", 3 );
604 append( sb, "", 0 );
605
606 append( sb, "author (Default: true)", 2 );
607 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
608 append( sb, "Expression: ${author}", 3 );
609 append( sb, "", 0 );
610
611 append( sb, "bootclasspath", 2 );
612 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
613 append( sb, "Expression: ${bootclasspath}", 3 );
614 append( sb, "", 0 );
615
616 append( sb, "bootclasspathArtifacts", 2 );
617 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 );
618 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
619 append( sb, "", 0 );
620
621 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
622 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 );
623 append( sb, "Expression: ${bottom}", 3 );
624 append( sb, "", 0 );
625
626 append( sb, "breakiterator (Default: false)", 2 );
627 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
628 append( sb, "Expression: ${breakiterator}", 3 );
629 append( sb, "", 0 );
630
631 append( sb, "charset", 2 );
632 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 );
633 append( sb, "Expression: ${charset}", 3 );
634 append( sb, "", 0 );
635
636 append( sb, "debug (Default: false)", 2 );
637 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
638 append( sb, "Expression: ${debug}", 3 );
639 append( sb, "", 0 );
640
641 append( sb, "dependencySourceExcludes", 2 );
642 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
643 append( sb, "", 0 );
644
645 append( sb, "dependencySourceIncludes", 2 );
646 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
647 append( sb, "", 0 );
648
649 append( sb, "destDir", 2 );
650 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
651 append( sb, "Expression: ${destDir}", 3 );
652 append( sb, "", 0 );
653
654 append( sb, "detectJavaApiLink (Default: true)", 2 );
655 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
656 append( sb, "Expression: ${detectJavaApiLink}", 3 );
657 append( sb, "", 0 );
658
659 append( sb, "detectLinks (Default: false)", 2 );
660 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
661 append( sb, "Expression: ${detectLinks}", 3 );
662 append( sb, "", 0 );
663
664 append( sb, "detectOfflineLinks (Default: true)", 2 );
665 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
666 append( sb, "Expression: ${detectOfflineLinks}", 3 );
667 append( sb, "", 0 );
668
669 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
670 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
671 append( sb, "Expression: ${docencoding}", 3 );
672 append( sb, "", 0 );
673
674 append( sb, "docfilessubdirs (Default: false)", 2 );
675 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
676 append( sb, "Expression: ${docfilessubdirs}", 3 );
677 append( sb, "", 0 );
678
679 append( sb, "doclet", 2 );
680 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
681 append( sb, "Expression: ${doclet}", 3 );
682 append( sb, "", 0 );
683
684 append( sb, "docletArtifact", 2 );
685 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 );
686 append( sb, "Expression: ${docletArtifact}", 3 );
687 append( sb, "", 0 );
688
689 append( sb, "docletArtifacts", 2 );
690 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 );
691 append( sb, "Expression: ${docletArtifacts}", 3 );
692 append( sb, "", 0 );
693
694 append( sb, "docletPath", 2 );
695 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
696 append( sb, "Expression: ${docletPath}", 3 );
697 append( sb, "", 0 );
698
699 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
700 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
701 append( sb, "Expression: ${doctitle}", 3 );
702 append( sb, "", 0 );
703
704 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
705 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 );
706 append( sb, "Expression: ${encoding}", 3 );
707 append( sb, "", 0 );
708
709 append( sb, "excludedocfilessubdir", 2 );
710 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 );
711 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
712 append( sb, "", 0 );
713
714 append( sb, "excludePackageNames", 2 );
715 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
716 append( sb, "Expression: ${excludePackageNames}", 3 );
717 append( sb, "", 0 );
718
719 append( sb, "extdirs", 2 );
720 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
721 append( sb, "Expression: ${extdirs}", 3 );
722 append( sb, "", 0 );
723
724 append( sb, "failOnError (Default: true)", 2 );
725 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
726 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
727 append( sb, "", 0 );
728
729 append( sb, "finalName", 2 );
730 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 );
731 append( sb, "Expression: ${project.build.finalName}", 3 );
732 append( sb, "", 0 );
733
734 append( sb, "footer", 2 );
735 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
736 append( sb, "Expression: ${footer}", 3 );
737 append( sb, "", 0 );
738
739 append( sb, "groups", 2 );
740 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
741 append( sb, "Expression: ${groups}", 3 );
742 append( sb, "", 0 );
743
744 append( sb, "header", 2 );
745 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
746 append( sb, "Expression: ${header}", 3 );
747 append( sb, "", 0 );
748
749 append( sb, "helpfile", 2 );
750 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
751 append( sb, "Expression: ${helpfile}", 3 );
752 append( sb, "", 0 );
753
754 append( sb, "includeDependencySources (Default: false)", 2 );
755 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
756 append( sb, "", 0 );
757
758 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
759 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
760 append( sb, "", 0 );
761
762 append( sb, "jarOutputDirectory", 2 );
763 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
764 append( sb, "Expression: ${project.build.directory}", 3 );
765 append( sb, "", 0 );
766
767 append( sb, "javaApiLinks", 2 );
768 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
769 append( sb, "Expression: ${javaApiLinks}", 3 );
770 append( sb, "", 0 );
771
772 append( sb, "javadocDirectory", 2 );
773 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 );
774 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
775 append( sb, "", 0 );
776
777 append( sb, "javadocExecutable", 2 );
778 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 );
779 append( sb, "Expression: ${javadocExecutable}", 3 );
780 append( sb, "", 0 );
781
782 append( sb, "javadocVersion", 2 );
783 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
784 append( sb, "Expression: ${javadocVersion}", 3 );
785 append( sb, "", 0 );
786
787 append( sb, "keywords (Default: false)", 2 );
788 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 );
789 append( sb, "Expression: ${keywords}", 3 );
790 append( sb, "", 0 );
791
792 append( sb, "links", 2 );
793 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
794 append( sb, "Expression: ${links}", 3 );
795 append( sb, "", 0 );
796
797 append( sb, "linksource (Default: false)", 2 );
798 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 );
799 append( sb, "Expression: ${linksource}", 3 );
800 append( sb, "", 0 );
801
802 append( sb, "locale", 2 );
803 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
804 append( sb, "Expression: ${locale}", 3 );
805 append( sb, "", 0 );
806
807 append( sb, "localRepository", 2 );
808 append( sb, "The local repository where the artifacts are located.", 3 );
809 append( sb, "Expression: ${localRepository}", 3 );
810 append( sb, "", 0 );
811
812 append( sb, "maxmemory", 2 );
813 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 );
814 append( sb, "Expression: ${maxmemory}", 3 );
815 append( sb, "", 0 );
816
817 append( sb, "minmemory", 2 );
818 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 );
819 append( sb, "Expression: ${minmemory}", 3 );
820 append( sb, "", 0 );
821
822 append( sb, "nocomment (Default: false)", 2 );
823 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 );
824 append( sb, "Expression: ${nocomment}", 3 );
825 append( sb, "", 0 );
826
827 append( sb, "nodeprecated (Default: false)", 2 );
828 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
829 append( sb, "Expression: ${nodeprecated}", 3 );
830 append( sb, "", 0 );
831
832 append( sb, "nodeprecatedlist (Default: false)", 2 );
833 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 );
834 append( sb, "Expression: ${nodeprecatedlist}", 3 );
835 append( sb, "", 0 );
836
837 append( sb, "nohelp (Default: false)", 2 );
838 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 );
839 append( sb, "Expression: ${nohelp}", 3 );
840 append( sb, "", 0 );
841
842 append( sb, "noindex (Default: false)", 2 );
843 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
844 append( sb, "Expression: ${noindex}", 3 );
845 append( sb, "", 0 );
846
847 append( sb, "nonavbar (Default: false)", 2 );
848 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
849 append( sb, "Expression: ${nonavbar}", 3 );
850 append( sb, "", 0 );
851
852 append( sb, "nooverview (Default: false)", 2 );
853 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
854 append( sb, "Expression: ${nooverview}", 3 );
855 append( sb, "", 0 );
856
857 append( sb, "noqualifier", 2 );
858 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
859 append( sb, "Expression: ${noqualifier}", 3 );
860 append( sb, "", 0 );
861
862 append( sb, "nosince (Default: false)", 2 );
863 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
864 append( sb, "Expression: ${nosince}", 3 );
865 append( sb, "", 0 );
866
867 append( sb, "notimestamp (Default: false)", 2 );
868 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 );
869 append( sb, "Expression: ${notimestamp}", 3 );
870 append( sb, "", 0 );
871
872 append( sb, "notree (Default: false)", 2 );
873 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
874 append( sb, "Expression: ${notree}", 3 );
875 append( sb, "", 0 );
876
877 append( sb, "offlineLinks", 2 );
878 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
879 append( sb, "Expression: ${offlineLinks}", 3 );
880 append( sb, "", 0 );
881
882 append( sb, "old (Default: false)", 2 );
883 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
884 append( sb, "Expression: ${old}", 3 );
885 append( sb, "", 0 );
886
887 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
888 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
889 append( sb, "Required: Yes", 3 );
890 append( sb, "Expression: ${destDir}", 3 );
891 append( sb, "", 0 );
892
893 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
894 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 );
895 append( sb, "Expression: ${overview}", 3 );
896 append( sb, "", 0 );
897
898 append( sb, "packagesheader", 2 );
899 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
900 append( sb, "Expression: ${packagesheader}", 3 );
901 append( sb, "", 0 );
902
903 append( sb, "proxyHost", 2 );
904 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
905 append( sb, "", 0 );
906 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 );
907 append( sb, "Expression: ${proxyHost}", 3 );
908 append( sb, "", 0 );
909
910 append( sb, "proxyPort", 2 );
911 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
912 append( sb, "", 0 );
913 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 );
914 append( sb, "Expression: ${proxyPort}", 3 );
915 append( sb, "", 0 );
916
917 append( sb, "quiet (Default: false)", 2 );
918 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 );
919 append( sb, "Expression: ${quiet}", 3 );
920 append( sb, "", 0 );
921
922 append( sb, "remoteRepositories", 2 );
923 append( sb, "The remote repositories where artifacts are located.", 3 );
924 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
925 append( sb, "", 0 );
926
927 append( sb, "resourcesArtifacts", 2 );
928 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 );
929 append( sb, "Expression: ${resourcesArtifacts}", 3 );
930 append( sb, "", 0 );
931
932 append( sb, "serialwarn (Default: false)", 2 );
933 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
934 append( sb, "Expression: ${serialwarn}", 3 );
935 append( sb, "", 0 );
936
937 append( sb, "show (Default: protected)", 2 );
938 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 );
939 append( sb, "Expression: ${show}", 3 );
940 append( sb, "", 0 );
941
942 append( sb, "skip (Default: false)", 2 );
943 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
944 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
945 append( sb, "", 0 );
946
947 append( sb, "source", 2 );
948 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
949 append( sb, "Expression: ${source}", 3 );
950 append( sb, "", 0 );
951
952 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
953 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
954 append( sb, "", 0 );
955
956 append( sb, "sourcepath", 2 );
957 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
958 append( sb, "Expression: ${sourcepath}", 3 );
959 append( sb, "", 0 );
960
961 append( sb, "sourcetab", 2 );
962 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 );
963 append( sb, "Expression: ${sourcetab}", 3 );
964 append( sb, "", 0 );
965
966 append( sb, "splitindex (Default: false)", 2 );
967 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 );
968 append( sb, "Expression: ${splitindex}", 3 );
969 append( sb, "", 0 );
970
971 append( sb, "stylesheet (Default: java)", 2 );
972 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
973 append( sb, "Expression: ${stylesheet}", 3 );
974 append( sb, "", 0 );
975
976 append( sb, "stylesheetfile", 2 );
977 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
978 append( sb, "Expression: ${stylesheetfile}", 3 );
979 append( sb, "", 0 );
980
981 append( sb, "subpackages", 2 );
982 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 );
983 append( sb, "Expression: ${subpackages}", 3 );
984 append( sb, "", 0 );
985
986 append( sb, "taglet", 2 );
987 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 );
988 append( sb, "Expression: ${taglet}", 3 );
989 append( sb, "", 0 );
990
991 append( sb, "tagletArtifact", 2 );
992 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 );
993 append( sb, "Expression: ${tagletArtifact}", 3 );
994 append( sb, "", 0 );
995
996 append( sb, "tagletArtifacts", 2 );
997 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 );
998 append( sb, "Expression: ${tagletArtifacts}", 3 );
999 append( sb, "", 0 );
1000
1001 append( sb, "tagletpath", 2 );
1002 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
1003 append( sb, "Expression: ${tagletpath}", 3 );
1004 append( sb, "", 0 );
1005
1006 append( sb, "taglets", 2 );
1007 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 );
1008 append( sb, "Expression: ${taglets}", 3 );
1009 append( sb, "", 0 );
1010
1011 append( sb, "tags", 2 );
1012 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
1013 append( sb, "Expression: ${tags}", 3 );
1014 append( sb, "", 0 );
1015
1016 append( sb, "top", 2 );
1017 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
1018 append( sb, "Expression: ${top}", 3 );
1019 append( sb, "", 0 );
1020
1021 append( sb, "use (Default: true)", 2 );
1022 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
1023 append( sb, "Expression: ${use}", 3 );
1024 append( sb, "", 0 );
1025
1026 append( sb, "useDefaultManifestFile (Default: false)", 2 );
1027 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
1028 append( sb, "", 0 );
1029
1030 append( sb, "useStandardDocletOptions (Default: true)", 2 );
1031 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 );
1032 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
1033 append( sb, "", 0 );
1034
1035 append( sb, "validateLinks (Default: false)", 2 );
1036 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
1037 append( sb, "Expression: ${validateLinks}", 3 );
1038 append( sb, "", 0 );
1039
1040 append( sb, "verbose (Default: false)", 2 );
1041 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
1042 append( sb, "Expression: ${verbose}", 3 );
1043 append( sb, "", 0 );
1044
1045 append( sb, "version (Default: true)", 2 );
1046 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
1047 append( sb, "Expression: ${version}", 3 );
1048 append( sb, "", 0 );
1049
1050 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
1051 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
1052 append( sb, "Expression: ${windowtitle}", 3 );
1053 append( sb, "", 0 );
1054 }
1055 }
1056
1057 if ( goal == null || goal.length() <= 0 || "fix".equals( goal ) )
1058 {
1059 append( sb, "javadoc:fix", 0 );
1060 append( sb, "Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.", 1 );
1061 append( sb, "", 0 );
1062 if ( detail )
1063 {
1064 append( sb, "Available parameters:", 1 );
1065 append( sb, "", 0 );
1066
1067 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
1068 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
1069 append( sb, "Expression: ${comparisonVersion}", 3 );
1070 append( sb, "", 0 );
1071
1072 append( sb, "defaultAuthor", 2 );
1073 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
1074 append( sb, "Expression: ${defaultAuthor}", 3 );
1075 append( sb, "", 0 );
1076
1077 append( sb, "defaultSince (Default: ${project.version})", 2 );
1078 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
1079 append( sb, "Expression: ${defaultSince}", 3 );
1080 append( sb, "", 0 );
1081
1082 append( sb, "defaultVersion", 2 );
1083 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
1084 append( sb, "Expression: ${defaultVersion}", 3 );
1085 append( sb, "", 0 );
1086
1087 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1088 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
1089 append( sb, "Expression: ${encoding}", 3 );
1090 append( sb, "", 0 );
1091
1092 append( sb, "excludes", 2 );
1093 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
1094 append( sb, "Expression: ${excludes}", 3 );
1095 append( sb, "", 0 );
1096
1097 append( sb, "fixClassComment (Default: true)", 2 );
1098 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
1099 append( sb, "Expression: ${fixClassComment}", 3 );
1100 append( sb, "", 0 );
1101
1102 append( sb, "fixFieldComment (Default: true)", 2 );
1103 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
1104 append( sb, "Expression: ${fixFieldComment}", 3 );
1105 append( sb, "", 0 );
1106
1107 append( sb, "fixMethodComment (Default: true)", 2 );
1108 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
1109 append( sb, "Expression: ${fixMethodComment}", 3 );
1110 append( sb, "", 0 );
1111
1112 append( sb, "fixTags (Default: all)", 2 );
1113 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n-\tlink (fix only @link tag)\n", 3 );
1114 append( sb, "Expression: ${fixTags}", 3 );
1115 append( sb, "", 0 );
1116
1117 append( sb, "force", 2 );
1118 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
1119 append( sb, "Expression: ${force}", 3 );
1120 append( sb, "", 0 );
1121
1122 append( sb, "ignoreClirr (Default: false)", 2 );
1123 append( sb, "Flag to ignore or not Clirr.", 3 );
1124 append( sb, "Expression: ${ignoreClirr}", 3 );
1125 append( sb, "", 0 );
1126
1127 append( sb, "includes (Default: **/*.java)", 2 );
1128 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
1129 append( sb, "Expression: ${includes}", 3 );
1130 append( sb, "", 0 );
1131
1132 append( sb, "level (Default: protected)", 2 );
1133 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 );
1134 append( sb, "Expression: ${level}", 3 );
1135 append( sb, "", 0 );
1136
1137 append( sb, "localRepository", 2 );
1138 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
1139 append( sb, "Expression: ${localRepository}", 3 );
1140 append( sb, "", 0 );
1141
1142 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
1143 append( sb, "Output directory where Java classes will be rewritten.", 3 );
1144 append( sb, "Expression: ${outputDirectory}", 3 );
1145 append( sb, "", 0 );
1146 }
1147 }
1148
1149 if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
1150 {
1151 append( sb, "javadoc:help", 0 );
1152 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 );
1153 append( sb, "", 0 );
1154 if ( detail )
1155 {
1156 append( sb, "Available parameters:", 1 );
1157 append( sb, "", 0 );
1158
1159 append( sb, "detail (Default: false)", 2 );
1160 append( sb, "If true, display all settable properties for each goal.", 3 );
1161 append( sb, "Expression: ${detail}", 3 );
1162 append( sb, "", 0 );
1163
1164 append( sb, "goal", 2 );
1165 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
1166 append( sb, "Expression: ${goal}", 3 );
1167 append( sb, "", 0 );
1168
1169 append( sb, "indentSize (Default: 2)", 2 );
1170 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
1171 append( sb, "Expression: ${indentSize}", 3 );
1172 append( sb, "", 0 );
1173
1174 append( sb, "lineLength (Default: 80)", 2 );
1175 append( sb, "The maximum length of a display line, should be positive.", 3 );
1176 append( sb, "Expression: ${lineLength}", 3 );
1177 append( sb, "", 0 );
1178 }
1179 }
1180
1181 if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )
1182 {
1183 append( sb, "javadoc:jar", 0 );
1184 append( sb, "Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
1185 append( sb, "", 0 );
1186 if ( detail )
1187 {
1188 append( sb, "Available parameters:", 1 );
1189 append( sb, "", 0 );
1190
1191 append( sb, "additionalJOption", 2 );
1192 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
1193 append( sb, "Expression: ${additionalJOption}", 3 );
1194 append( sb, "", 0 );
1195
1196 append( sb, "additionalparam", 2 );
1197 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 );
1198 append( sb, "Expression: ${additionalparam}", 3 );
1199 append( sb, "", 0 );
1200
1201 append( sb, "additionnalDependencies", 2 );
1202 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
1203 append( sb, "", 0 );
1204
1205 append( sb, "aggregate (Default: false)", 2 );
1206 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
1207 append( sb, "", 0 );
1208 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
1209 append( sb, "Expression: ${aggregate}", 3 );
1210 append( sb, "", 0 );
1211
1212 append( sb, "archive", 2 );
1213 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
1214 append( sb, "", 0 );
1215
1216 append( sb, "attach (Default: true)", 2 );
1217 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
1218 append( sb, "Expression: ${attach}", 3 );
1219 append( sb, "", 0 );
1220
1221 append( sb, "author (Default: true)", 2 );
1222 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
1223 append( sb, "Expression: ${author}", 3 );
1224 append( sb, "", 0 );
1225
1226 append( sb, "bootclasspath", 2 );
1227 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
1228 append( sb, "Expression: ${bootclasspath}", 3 );
1229 append( sb, "", 0 );
1230
1231 append( sb, "bootclasspathArtifacts", 2 );
1232 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 );
1233 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
1234 append( sb, "", 0 );
1235
1236 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
1237 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 );
1238 append( sb, "Expression: ${bottom}", 3 );
1239 append( sb, "", 0 );
1240
1241 append( sb, "breakiterator (Default: false)", 2 );
1242 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
1243 append( sb, "Expression: ${breakiterator}", 3 );
1244 append( sb, "", 0 );
1245
1246 append( sb, "charset", 2 );
1247 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 );
1248 append( sb, "Expression: ${charset}", 3 );
1249 append( sb, "", 0 );
1250
1251 append( sb, "debug (Default: false)", 2 );
1252 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
1253 append( sb, "Expression: ${debug}", 3 );
1254 append( sb, "", 0 );
1255
1256 append( sb, "dependencySourceExcludes", 2 );
1257 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
1258 append( sb, "", 0 );
1259
1260 append( sb, "dependencySourceIncludes", 2 );
1261 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
1262 append( sb, "", 0 );
1263
1264 append( sb, "destDir", 2 );
1265 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
1266 append( sb, "Expression: ${destDir}", 3 );
1267 append( sb, "", 0 );
1268
1269 append( sb, "detectJavaApiLink (Default: true)", 2 );
1270 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
1271 append( sb, "Expression: ${detectJavaApiLink}", 3 );
1272 append( sb, "", 0 );
1273
1274 append( sb, "detectLinks (Default: false)", 2 );
1275 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
1276 append( sb, "Expression: ${detectLinks}", 3 );
1277 append( sb, "", 0 );
1278
1279 append( sb, "detectOfflineLinks (Default: true)", 2 );
1280 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
1281 append( sb, "Expression: ${detectOfflineLinks}", 3 );
1282 append( sb, "", 0 );
1283
1284 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
1285 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
1286 append( sb, "Expression: ${docencoding}", 3 );
1287 append( sb, "", 0 );
1288
1289 append( sb, "docfilessubdirs (Default: false)", 2 );
1290 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
1291 append( sb, "Expression: ${docfilessubdirs}", 3 );
1292 append( sb, "", 0 );
1293
1294 append( sb, "doclet", 2 );
1295 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
1296 append( sb, "Expression: ${doclet}", 3 );
1297 append( sb, "", 0 );
1298
1299 append( sb, "docletArtifact", 2 );
1300 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 );
1301 append( sb, "Expression: ${docletArtifact}", 3 );
1302 append( sb, "", 0 );
1303
1304 append( sb, "docletArtifacts", 2 );
1305 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 );
1306 append( sb, "Expression: ${docletArtifacts}", 3 );
1307 append( sb, "", 0 );
1308
1309 append( sb, "docletPath", 2 );
1310 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
1311 append( sb, "Expression: ${docletPath}", 3 );
1312 append( sb, "", 0 );
1313
1314 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
1315 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
1316 append( sb, "Expression: ${doctitle}", 3 );
1317 append( sb, "", 0 );
1318
1319 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1320 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 );
1321 append( sb, "Expression: ${encoding}", 3 );
1322 append( sb, "", 0 );
1323
1324 append( sb, "excludedocfilessubdir", 2 );
1325 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 );
1326 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
1327 append( sb, "", 0 );
1328
1329 append( sb, "excludePackageNames", 2 );
1330 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
1331 append( sb, "Expression: ${excludePackageNames}", 3 );
1332 append( sb, "", 0 );
1333
1334 append( sb, "extdirs", 2 );
1335 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
1336 append( sb, "Expression: ${extdirs}", 3 );
1337 append( sb, "", 0 );
1338
1339 append( sb, "failOnError (Default: true)", 2 );
1340 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
1341 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
1342 append( sb, "", 0 );
1343
1344 append( sb, "finalName", 2 );
1345 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 );
1346 append( sb, "Expression: ${project.build.finalName}", 3 );
1347 append( sb, "", 0 );
1348
1349 append( sb, "footer", 2 );
1350 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
1351 append( sb, "Expression: ${footer}", 3 );
1352 append( sb, "", 0 );
1353
1354 append( sb, "groups", 2 );
1355 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
1356 append( sb, "Expression: ${groups}", 3 );
1357 append( sb, "", 0 );
1358
1359 append( sb, "header", 2 );
1360 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
1361 append( sb, "Expression: ${header}", 3 );
1362 append( sb, "", 0 );
1363
1364 append( sb, "helpfile", 2 );
1365 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
1366 append( sb, "Expression: ${helpfile}", 3 );
1367 append( sb, "", 0 );
1368
1369 append( sb, "includeDependencySources (Default: false)", 2 );
1370 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
1371 append( sb, "", 0 );
1372
1373 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
1374 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
1375 append( sb, "", 0 );
1376
1377 append( sb, "jarOutputDirectory", 2 );
1378 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
1379 append( sb, "Expression: ${project.build.directory}", 3 );
1380 append( sb, "", 0 );
1381
1382 append( sb, "javaApiLinks", 2 );
1383 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
1384 append( sb, "Expression: ${javaApiLinks}", 3 );
1385 append( sb, "", 0 );
1386
1387 append( sb, "javadocDirectory", 2 );
1388 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 );
1389 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
1390 append( sb, "", 0 );
1391
1392 append( sb, "javadocExecutable", 2 );
1393 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 );
1394 append( sb, "Expression: ${javadocExecutable}", 3 );
1395 append( sb, "", 0 );
1396
1397 append( sb, "javadocVersion", 2 );
1398 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
1399 append( sb, "Expression: ${javadocVersion}", 3 );
1400 append( sb, "", 0 );
1401
1402 append( sb, "keywords (Default: false)", 2 );
1403 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 );
1404 append( sb, "Expression: ${keywords}", 3 );
1405 append( sb, "", 0 );
1406
1407 append( sb, "links", 2 );
1408 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
1409 append( sb, "Expression: ${links}", 3 );
1410 append( sb, "", 0 );
1411
1412 append( sb, "linksource (Default: false)", 2 );
1413 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 );
1414 append( sb, "Expression: ${linksource}", 3 );
1415 append( sb, "", 0 );
1416
1417 append( sb, "locale", 2 );
1418 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
1419 append( sb, "Expression: ${locale}", 3 );
1420 append( sb, "", 0 );
1421
1422 append( sb, "localRepository", 2 );
1423 append( sb, "The local repository where the artifacts are located.", 3 );
1424 append( sb, "Expression: ${localRepository}", 3 );
1425 append( sb, "", 0 );
1426
1427 append( sb, "maxmemory", 2 );
1428 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 );
1429 append( sb, "Expression: ${maxmemory}", 3 );
1430 append( sb, "", 0 );
1431
1432 append( sb, "minmemory", 2 );
1433 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 );
1434 append( sb, "Expression: ${minmemory}", 3 );
1435 append( sb, "", 0 );
1436
1437 append( sb, "nocomment (Default: false)", 2 );
1438 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 );
1439 append( sb, "Expression: ${nocomment}", 3 );
1440 append( sb, "", 0 );
1441
1442 append( sb, "nodeprecated (Default: false)", 2 );
1443 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
1444 append( sb, "Expression: ${nodeprecated}", 3 );
1445 append( sb, "", 0 );
1446
1447 append( sb, "nodeprecatedlist (Default: false)", 2 );
1448 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 );
1449 append( sb, "Expression: ${nodeprecatedlist}", 3 );
1450 append( sb, "", 0 );
1451
1452 append( sb, "nohelp (Default: false)", 2 );
1453 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 );
1454 append( sb, "Expression: ${nohelp}", 3 );
1455 append( sb, "", 0 );
1456
1457 append( sb, "noindex (Default: false)", 2 );
1458 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
1459 append( sb, "Expression: ${noindex}", 3 );
1460 append( sb, "", 0 );
1461
1462 append( sb, "nonavbar (Default: false)", 2 );
1463 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
1464 append( sb, "Expression: ${nonavbar}", 3 );
1465 append( sb, "", 0 );
1466
1467 append( sb, "nooverview (Default: false)", 2 );
1468 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
1469 append( sb, "Expression: ${nooverview}", 3 );
1470 append( sb, "", 0 );
1471
1472 append( sb, "noqualifier", 2 );
1473 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
1474 append( sb, "Expression: ${noqualifier}", 3 );
1475 append( sb, "", 0 );
1476
1477 append( sb, "nosince (Default: false)", 2 );
1478 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
1479 append( sb, "Expression: ${nosince}", 3 );
1480 append( sb, "", 0 );
1481
1482 append( sb, "notimestamp (Default: false)", 2 );
1483 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 );
1484 append( sb, "Expression: ${notimestamp}", 3 );
1485 append( sb, "", 0 );
1486
1487 append( sb, "notree (Default: false)", 2 );
1488 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
1489 append( sb, "Expression: ${notree}", 3 );
1490 append( sb, "", 0 );
1491
1492 append( sb, "offlineLinks", 2 );
1493 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
1494 append( sb, "Expression: ${offlineLinks}", 3 );
1495 append( sb, "", 0 );
1496
1497 append( sb, "old (Default: false)", 2 );
1498 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
1499 append( sb, "Expression: ${old}", 3 );
1500 append( sb, "", 0 );
1501
1502 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
1503 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
1504 append( sb, "Required: Yes", 3 );
1505 append( sb, "Expression: ${destDir}", 3 );
1506 append( sb, "", 0 );
1507
1508 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
1509 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 );
1510 append( sb, "Expression: ${overview}", 3 );
1511 append( sb, "", 0 );
1512
1513 append( sb, "packagesheader", 2 );
1514 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
1515 append( sb, "Expression: ${packagesheader}", 3 );
1516 append( sb, "", 0 );
1517
1518 append( sb, "proxyHost", 2 );
1519 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
1520 append( sb, "", 0 );
1521 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 );
1522 append( sb, "Expression: ${proxyHost}", 3 );
1523 append( sb, "", 0 );
1524
1525 append( sb, "proxyPort", 2 );
1526 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
1527 append( sb, "", 0 );
1528 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 );
1529 append( sb, "Expression: ${proxyPort}", 3 );
1530 append( sb, "", 0 );
1531
1532 append( sb, "quiet (Default: false)", 2 );
1533 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 );
1534 append( sb, "Expression: ${quiet}", 3 );
1535 append( sb, "", 0 );
1536
1537 append( sb, "remoteRepositories", 2 );
1538 append( sb, "The remote repositories where artifacts are located.", 3 );
1539 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
1540 append( sb, "", 0 );
1541
1542 append( sb, "resourcesArtifacts", 2 );
1543 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 );
1544 append( sb, "Expression: ${resourcesArtifacts}", 3 );
1545 append( sb, "", 0 );
1546
1547 append( sb, "serialwarn (Default: false)", 2 );
1548 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
1549 append( sb, "Expression: ${serialwarn}", 3 );
1550 append( sb, "", 0 );
1551
1552 append( sb, "show (Default: protected)", 2 );
1553 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 );
1554 append( sb, "Expression: ${show}", 3 );
1555 append( sb, "", 0 );
1556
1557 append( sb, "skip (Default: false)", 2 );
1558 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
1559 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
1560 append( sb, "", 0 );
1561
1562 append( sb, "source", 2 );
1563 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
1564 append( sb, "Expression: ${source}", 3 );
1565 append( sb, "", 0 );
1566
1567 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
1568 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
1569 append( sb, "", 0 );
1570
1571 append( sb, "sourcepath", 2 );
1572 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
1573 append( sb, "Expression: ${sourcepath}", 3 );
1574 append( sb, "", 0 );
1575
1576 append( sb, "sourcetab", 2 );
1577 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 );
1578 append( sb, "Expression: ${sourcetab}", 3 );
1579 append( sb, "", 0 );
1580
1581 append( sb, "splitindex (Default: false)", 2 );
1582 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 );
1583 append( sb, "Expression: ${splitindex}", 3 );
1584 append( sb, "", 0 );
1585
1586 append( sb, "stylesheet (Default: java)", 2 );
1587 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
1588 append( sb, "Expression: ${stylesheet}", 3 );
1589 append( sb, "", 0 );
1590
1591 append( sb, "stylesheetfile", 2 );
1592 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
1593 append( sb, "Expression: ${stylesheetfile}", 3 );
1594 append( sb, "", 0 );
1595
1596 append( sb, "subpackages", 2 );
1597 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 );
1598 append( sb, "Expression: ${subpackages}", 3 );
1599 append( sb, "", 0 );
1600
1601 append( sb, "taglet", 2 );
1602 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 );
1603 append( sb, "Expression: ${taglet}", 3 );
1604 append( sb, "", 0 );
1605
1606 append( sb, "tagletArtifact", 2 );
1607 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 );
1608 append( sb, "Expression: ${tagletArtifact}", 3 );
1609 append( sb, "", 0 );
1610
1611 append( sb, "tagletArtifacts", 2 );
1612 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 );
1613 append( sb, "Expression: ${tagletArtifacts}", 3 );
1614 append( sb, "", 0 );
1615
1616 append( sb, "tagletpath", 2 );
1617 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
1618 append( sb, "Expression: ${tagletpath}", 3 );
1619 append( sb, "", 0 );
1620
1621 append( sb, "taglets", 2 );
1622 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 );
1623 append( sb, "Expression: ${taglets}", 3 );
1624 append( sb, "", 0 );
1625
1626 append( sb, "tags", 2 );
1627 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
1628 append( sb, "Expression: ${tags}", 3 );
1629 append( sb, "", 0 );
1630
1631 append( sb, "top", 2 );
1632 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
1633 append( sb, "Expression: ${top}", 3 );
1634 append( sb, "", 0 );
1635
1636 append( sb, "use (Default: true)", 2 );
1637 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
1638 append( sb, "Expression: ${use}", 3 );
1639 append( sb, "", 0 );
1640
1641 append( sb, "useDefaultManifestFile (Default: false)", 2 );
1642 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
1643 append( sb, "", 0 );
1644
1645 append( sb, "useStandardDocletOptions (Default: true)", 2 );
1646 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 );
1647 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
1648 append( sb, "", 0 );
1649
1650 append( sb, "validateLinks (Default: false)", 2 );
1651 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
1652 append( sb, "Expression: ${validateLinks}", 3 );
1653 append( sb, "", 0 );
1654
1655 append( sb, "verbose (Default: false)", 2 );
1656 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
1657 append( sb, "Expression: ${verbose}", 3 );
1658 append( sb, "", 0 );
1659
1660 append( sb, "version (Default: true)", 2 );
1661 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
1662 append( sb, "Expression: ${version}", 3 );
1663 append( sb, "", 0 );
1664
1665 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
1666 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
1667 append( sb, "Expression: ${windowtitle}", 3 );
1668 append( sb, "", 0 );
1669 }
1670 }
1671
1672 if ( goal == null || goal.length() <= 0 || "javadoc".equals( goal ) )
1673 {
1674 append( sb, "javadoc:javadoc", 0 );
1675 append( sb, "Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.", 1 );
1676 append( sb, "", 0 );
1677 if ( detail )
1678 {
1679 append( sb, "Available parameters:", 1 );
1680 append( sb, "", 0 );
1681
1682 append( sb, "additionalJOption", 2 );
1683 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
1684 append( sb, "Expression: ${additionalJOption}", 3 );
1685 append( sb, "", 0 );
1686
1687 append( sb, "additionalparam", 2 );
1688 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 );
1689 append( sb, "Expression: ${additionalparam}", 3 );
1690 append( sb, "", 0 );
1691
1692 append( sb, "additionnalDependencies", 2 );
1693 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
1694 append( sb, "", 0 );
1695
1696 append( sb, "aggregate (Default: false)", 2 );
1697 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
1698 append( sb, "", 0 );
1699 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
1700 append( sb, "Expression: ${aggregate}", 3 );
1701 append( sb, "", 0 );
1702
1703 append( sb, "author (Default: true)", 2 );
1704 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
1705 append( sb, "Expression: ${author}", 3 );
1706 append( sb, "", 0 );
1707
1708 append( sb, "bootclasspath", 2 );
1709 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
1710 append( sb, "Expression: ${bootclasspath}", 3 );
1711 append( sb, "", 0 );
1712
1713 append( sb, "bootclasspathArtifacts", 2 );
1714 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 );
1715 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
1716 append( sb, "", 0 );
1717
1718 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
1719 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 );
1720 append( sb, "Expression: ${bottom}", 3 );
1721 append( sb, "", 0 );
1722
1723 append( sb, "breakiterator (Default: false)", 2 );
1724 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
1725 append( sb, "Expression: ${breakiterator}", 3 );
1726 append( sb, "", 0 );
1727
1728 append( sb, "charset", 2 );
1729 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 );
1730 append( sb, "Expression: ${charset}", 3 );
1731 append( sb, "", 0 );
1732
1733 append( sb, "debug (Default: false)", 2 );
1734 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
1735 append( sb, "Expression: ${debug}", 3 );
1736 append( sb, "", 0 );
1737
1738 append( sb, "dependencySourceExcludes", 2 );
1739 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
1740 append( sb, "", 0 );
1741
1742 append( sb, "dependencySourceIncludes", 2 );
1743 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
1744 append( sb, "", 0 );
1745
1746 append( sb, "description", 2 );
1747 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
1748 append( sb, "Expression: ${description}", 3 );
1749 append( sb, "", 0 );
1750
1751 append( sb, "destDir (Default: apidocs)", 2 );
1752 append( sb, "The name of the destination directory.\n", 3 );
1753 append( sb, "Expression: ${destDir}", 3 );
1754 append( sb, "", 0 );
1755
1756 append( sb, "detectJavaApiLink (Default: true)", 2 );
1757 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
1758 append( sb, "Expression: ${detectJavaApiLink}", 3 );
1759 append( sb, "", 0 );
1760
1761 append( sb, "detectLinks (Default: false)", 2 );
1762 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
1763 append( sb, "Expression: ${detectLinks}", 3 );
1764 append( sb, "", 0 );
1765
1766 append( sb, "detectOfflineLinks (Default: true)", 2 );
1767 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
1768 append( sb, "Expression: ${detectOfflineLinks}", 3 );
1769 append( sb, "", 0 );
1770
1771 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
1772 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
1773 append( sb, "Expression: ${docencoding}", 3 );
1774 append( sb, "", 0 );
1775
1776 append( sb, "docfilessubdirs (Default: false)", 2 );
1777 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
1778 append( sb, "Expression: ${docfilessubdirs}", 3 );
1779 append( sb, "", 0 );
1780
1781 append( sb, "doclet", 2 );
1782 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
1783 append( sb, "Expression: ${doclet}", 3 );
1784 append( sb, "", 0 );
1785
1786 append( sb, "docletArtifact", 2 );
1787 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 );
1788 append( sb, "Expression: ${docletArtifact}", 3 );
1789 append( sb, "", 0 );
1790
1791 append( sb, "docletArtifacts", 2 );
1792 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 );
1793 append( sb, "Expression: ${docletArtifacts}", 3 );
1794 append( sb, "", 0 );
1795
1796 append( sb, "docletPath", 2 );
1797 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
1798 append( sb, "Expression: ${docletPath}", 3 );
1799 append( sb, "", 0 );
1800
1801 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
1802 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
1803 append( sb, "Expression: ${doctitle}", 3 );
1804 append( sb, "", 0 );
1805
1806 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1807 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 );
1808 append( sb, "Expression: ${encoding}", 3 );
1809 append( sb, "", 0 );
1810
1811 append( sb, "excludedocfilessubdir", 2 );
1812 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 );
1813 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
1814 append( sb, "", 0 );
1815
1816 append( sb, "excludePackageNames", 2 );
1817 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
1818 append( sb, "Expression: ${excludePackageNames}", 3 );
1819 append( sb, "", 0 );
1820
1821 append( sb, "extdirs", 2 );
1822 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
1823 append( sb, "Expression: ${extdirs}", 3 );
1824 append( sb, "", 0 );
1825
1826 append( sb, "failOnError (Default: true)", 2 );
1827 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
1828 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
1829 append( sb, "", 0 );
1830
1831 append( sb, "footer", 2 );
1832 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
1833 append( sb, "Expression: ${footer}", 3 );
1834 append( sb, "", 0 );
1835
1836 append( sb, "groups", 2 );
1837 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
1838 append( sb, "Expression: ${groups}", 3 );
1839 append( sb, "", 0 );
1840
1841 append( sb, "header", 2 );
1842 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
1843 append( sb, "Expression: ${header}", 3 );
1844 append( sb, "", 0 );
1845
1846 append( sb, "helpfile", 2 );
1847 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
1848 append( sb, "Expression: ${helpfile}", 3 );
1849 append( sb, "", 0 );
1850
1851 append( sb, "includeDependencySources (Default: false)", 2 );
1852 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
1853 append( sb, "", 0 );
1854
1855 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
1856 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
1857 append( sb, "", 0 );
1858
1859 append( sb, "javaApiLinks", 2 );
1860 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
1861 append( sb, "Expression: ${javaApiLinks}", 3 );
1862 append( sb, "", 0 );
1863
1864 append( sb, "javadocDirectory", 2 );
1865 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 );
1866 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
1867 append( sb, "", 0 );
1868
1869 append( sb, "javadocExecutable", 2 );
1870 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 );
1871 append( sb, "Expression: ${javadocExecutable}", 3 );
1872 append( sb, "", 0 );
1873
1874 append( sb, "javadocVersion", 2 );
1875 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
1876 append( sb, "Expression: ${javadocVersion}", 3 );
1877 append( sb, "", 0 );
1878
1879 append( sb, "keywords (Default: false)", 2 );
1880 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 );
1881 append( sb, "Expression: ${keywords}", 3 );
1882 append( sb, "", 0 );
1883
1884 append( sb, "links", 2 );
1885 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
1886 append( sb, "Expression: ${links}", 3 );
1887 append( sb, "", 0 );
1888
1889 append( sb, "linksource (Default: false)", 2 );
1890 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 );
1891 append( sb, "Expression: ${linksource}", 3 );
1892 append( sb, "", 0 );
1893
1894 append( sb, "locale", 2 );
1895 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
1896 append( sb, "Expression: ${locale}", 3 );
1897 append( sb, "", 0 );
1898
1899 append( sb, "localRepository", 2 );
1900 append( sb, "The local repository where the artifacts are located.", 3 );
1901 append( sb, "Expression: ${localRepository}", 3 );
1902 append( sb, "", 0 );
1903
1904 append( sb, "maxmemory", 2 );
1905 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 );
1906 append( sb, "Expression: ${maxmemory}", 3 );
1907 append( sb, "", 0 );
1908
1909 append( sb, "minmemory", 2 );
1910 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 );
1911 append( sb, "Expression: ${minmemory}", 3 );
1912 append( sb, "", 0 );
1913
1914 append( sb, "name", 2 );
1915 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
1916 append( sb, "Expression: ${name}", 3 );
1917 append( sb, "", 0 );
1918
1919 append( sb, "nocomment (Default: false)", 2 );
1920 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 );
1921 append( sb, "Expression: ${nocomment}", 3 );
1922 append( sb, "", 0 );
1923
1924 append( sb, "nodeprecated (Default: false)", 2 );
1925 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
1926 append( sb, "Expression: ${nodeprecated}", 3 );
1927 append( sb, "", 0 );
1928
1929 append( sb, "nodeprecatedlist (Default: false)", 2 );
1930 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 );
1931 append( sb, "Expression: ${nodeprecatedlist}", 3 );
1932 append( sb, "", 0 );
1933
1934 append( sb, "nohelp (Default: false)", 2 );
1935 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 );
1936 append( sb, "Expression: ${nohelp}", 3 );
1937 append( sb, "", 0 );
1938
1939 append( sb, "noindex (Default: false)", 2 );
1940 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
1941 append( sb, "Expression: ${noindex}", 3 );
1942 append( sb, "", 0 );
1943
1944 append( sb, "nonavbar (Default: false)", 2 );
1945 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
1946 append( sb, "Expression: ${nonavbar}", 3 );
1947 append( sb, "", 0 );
1948
1949 append( sb, "nooverview (Default: false)", 2 );
1950 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
1951 append( sb, "Expression: ${nooverview}", 3 );
1952 append( sb, "", 0 );
1953
1954 append( sb, "noqualifier", 2 );
1955 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
1956 append( sb, "Expression: ${noqualifier}", 3 );
1957 append( sb, "", 0 );
1958
1959 append( sb, "nosince (Default: false)", 2 );
1960 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
1961 append( sb, "Expression: ${nosince}", 3 );
1962 append( sb, "", 0 );
1963
1964 append( sb, "notimestamp (Default: false)", 2 );
1965 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 );
1966 append( sb, "Expression: ${notimestamp}", 3 );
1967 append( sb, "", 0 );
1968
1969 append( sb, "notree (Default: false)", 2 );
1970 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
1971 append( sb, "Expression: ${notree}", 3 );
1972 append( sb, "", 0 );
1973
1974 append( sb, "offlineLinks", 2 );
1975 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
1976 append( sb, "Expression: ${offlineLinks}", 3 );
1977 append( sb, "", 0 );
1978
1979 append( sb, "old (Default: false)", 2 );
1980 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
1981 append( sb, "Expression: ${old}", 3 );
1982 append( sb, "", 0 );
1983
1984 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
1985 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
1986 append( sb, "Required: Yes", 3 );
1987 append( sb, "Expression: ${destDir}", 3 );
1988 append( sb, "", 0 );
1989
1990 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
1991 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 );
1992 append( sb, "Expression: ${overview}", 3 );
1993 append( sb, "", 0 );
1994
1995 append( sb, "packagesheader", 2 );
1996 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
1997 append( sb, "Expression: ${packagesheader}", 3 );
1998 append( sb, "", 0 );
1999
2000 append( sb, "proxyHost", 2 );
2001 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
2002 append( sb, "", 0 );
2003 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 );
2004 append( sb, "Expression: ${proxyHost}", 3 );
2005 append( sb, "", 0 );
2006
2007 append( sb, "proxyPort", 2 );
2008 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
2009 append( sb, "", 0 );
2010 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 );
2011 append( sb, "Expression: ${proxyPort}", 3 );
2012 append( sb, "", 0 );
2013
2014 append( sb, "quiet (Default: false)", 2 );
2015 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 );
2016 append( sb, "Expression: ${quiet}", 3 );
2017 append( sb, "", 0 );
2018
2019 append( sb, "remoteRepositories", 2 );
2020 append( sb, "The remote repositories where artifacts are located.", 3 );
2021 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2022 append( sb, "", 0 );
2023
2024 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
2025 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
2026 append( sb, "Required: Yes", 3 );
2027 append( sb, "Expression: ${reportOutputDirectory}", 3 );
2028 append( sb, "", 0 );
2029
2030 append( sb, "resourcesArtifacts", 2 );
2031 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 );
2032 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2033 append( sb, "", 0 );
2034
2035 append( sb, "serialwarn (Default: false)", 2 );
2036 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2037 append( sb, "Expression: ${serialwarn}", 3 );
2038 append( sb, "", 0 );
2039
2040 append( sb, "show (Default: protected)", 2 );
2041 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 );
2042 append( sb, "Expression: ${show}", 3 );
2043 append( sb, "", 0 );
2044
2045 append( sb, "skip (Default: false)", 2 );
2046 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2047 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2048 append( sb, "", 0 );
2049
2050 append( sb, "source", 2 );
2051 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
2052 append( sb, "Expression: ${source}", 3 );
2053 append( sb, "", 0 );
2054
2055 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
2056 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
2057 append( sb, "", 0 );
2058
2059 append( sb, "sourcepath", 2 );
2060 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
2061 append( sb, "Expression: ${sourcepath}", 3 );
2062 append( sb, "", 0 );
2063
2064 append( sb, "sourcetab", 2 );
2065 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 );
2066 append( sb, "Expression: ${sourcetab}", 3 );
2067 append( sb, "", 0 );
2068
2069 append( sb, "splitindex (Default: false)", 2 );
2070 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 );
2071 append( sb, "Expression: ${splitindex}", 3 );
2072 append( sb, "", 0 );
2073
2074 append( sb, "stylesheet (Default: java)", 2 );
2075 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
2076 append( sb, "Expression: ${stylesheet}", 3 );
2077 append( sb, "", 0 );
2078
2079 append( sb, "stylesheetfile", 2 );
2080 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
2081 append( sb, "Expression: ${stylesheetfile}", 3 );
2082 append( sb, "", 0 );
2083
2084 append( sb, "subpackages", 2 );
2085 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 );
2086 append( sb, "Expression: ${subpackages}", 3 );
2087 append( sb, "", 0 );
2088
2089 append( sb, "taglet", 2 );
2090 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 );
2091 append( sb, "Expression: ${taglet}", 3 );
2092 append( sb, "", 0 );
2093
2094 append( sb, "tagletArtifact", 2 );
2095 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 );
2096 append( sb, "Expression: ${tagletArtifact}", 3 );
2097 append( sb, "", 0 );
2098
2099 append( sb, "tagletArtifacts", 2 );
2100 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 );
2101 append( sb, "Expression: ${tagletArtifacts}", 3 );
2102 append( sb, "", 0 );
2103
2104 append( sb, "tagletpath", 2 );
2105 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
2106 append( sb, "Expression: ${tagletpath}", 3 );
2107 append( sb, "", 0 );
2108
2109 append( sb, "taglets", 2 );
2110 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 );
2111 append( sb, "Expression: ${taglets}", 3 );
2112 append( sb, "", 0 );
2113
2114 append( sb, "tags", 2 );
2115 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
2116 append( sb, "Expression: ${tags}", 3 );
2117 append( sb, "", 0 );
2118
2119 append( sb, "top", 2 );
2120 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
2121 append( sb, "Expression: ${top}", 3 );
2122 append( sb, "", 0 );
2123
2124 append( sb, "use (Default: true)", 2 );
2125 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
2126 append( sb, "Expression: ${use}", 3 );
2127 append( sb, "", 0 );
2128
2129 append( sb, "useStandardDocletOptions (Default: true)", 2 );
2130 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 );
2131 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
2132 append( sb, "", 0 );
2133
2134 append( sb, "validateLinks (Default: false)", 2 );
2135 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
2136 append( sb, "Expression: ${validateLinks}", 3 );
2137 append( sb, "", 0 );
2138
2139 append( sb, "verbose (Default: false)", 2 );
2140 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
2141 append( sb, "Expression: ${verbose}", 3 );
2142 append( sb, "", 0 );
2143
2144 append( sb, "version (Default: true)", 2 );
2145 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
2146 append( sb, "Expression: ${version}", 3 );
2147 append( sb, "", 0 );
2148
2149 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
2150 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
2151 append( sb, "Expression: ${windowtitle}", 3 );
2152 append( sb, "", 0 );
2153 }
2154 }
2155
2156 if ( goal == null || goal.length() <= 0 || "resource-bundle".equals( goal ) )
2157 {
2158 append( sb, "javadoc:resource-bundle", 0 );
2159 append( sb, "Bundle AbstractJavadocMojo.javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
2160 append( sb, "", 0 );
2161 if ( detail )
2162 {
2163 append( sb, "Available parameters:", 1 );
2164 append( sb, "", 0 );
2165
2166 append( sb, "additionalJOption", 2 );
2167 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
2168 append( sb, "Expression: ${additionalJOption}", 3 );
2169 append( sb, "", 0 );
2170
2171 append( sb, "additionalparam", 2 );
2172 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 );
2173 append( sb, "Expression: ${additionalparam}", 3 );
2174 append( sb, "", 0 );
2175
2176 append( sb, "additionnalDependencies", 2 );
2177 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
2178 append( sb, "", 0 );
2179
2180 append( sb, "aggregate (Default: false)", 2 );
2181 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
2182 append( sb, "", 0 );
2183 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
2184 append( sb, "Expression: ${aggregate}", 3 );
2185 append( sb, "", 0 );
2186
2187 append( sb, "author (Default: true)", 2 );
2188 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
2189 append( sb, "Expression: ${author}", 3 );
2190 append( sb, "", 0 );
2191
2192 append( sb, "bootclasspath", 2 );
2193 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
2194 append( sb, "Expression: ${bootclasspath}", 3 );
2195 append( sb, "", 0 );
2196
2197 append( sb, "bootclasspathArtifacts", 2 );
2198 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 );
2199 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
2200 append( sb, "", 0 );
2201
2202 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
2203 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 );
2204 append( sb, "Expression: ${bottom}", 3 );
2205 append( sb, "", 0 );
2206
2207 append( sb, "breakiterator (Default: false)", 2 );
2208 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
2209 append( sb, "Expression: ${breakiterator}", 3 );
2210 append( sb, "", 0 );
2211
2212 append( sb, "charset", 2 );
2213 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 );
2214 append( sb, "Expression: ${charset}", 3 );
2215 append( sb, "", 0 );
2216
2217 append( sb, "debug (Default: false)", 2 );
2218 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
2219 append( sb, "Expression: ${debug}", 3 );
2220 append( sb, "", 0 );
2221
2222 append( sb, "dependencySourceExcludes", 2 );
2223 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
2224 append( sb, "", 0 );
2225
2226 append( sb, "dependencySourceIncludes", 2 );
2227 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
2228 append( sb, "", 0 );
2229
2230 append( sb, "detectJavaApiLink (Default: true)", 2 );
2231 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
2232 append( sb, "Expression: ${detectJavaApiLink}", 3 );
2233 append( sb, "", 0 );
2234
2235 append( sb, "detectLinks (Default: false)", 2 );
2236 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
2237 append( sb, "Expression: ${detectLinks}", 3 );
2238 append( sb, "", 0 );
2239
2240 append( sb, "detectOfflineLinks (Default: true)", 2 );
2241 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
2242 append( sb, "Expression: ${detectOfflineLinks}", 3 );
2243 append( sb, "", 0 );
2244
2245 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
2246 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
2247 append( sb, "Expression: ${docencoding}", 3 );
2248 append( sb, "", 0 );
2249
2250 append( sb, "docfilessubdirs (Default: false)", 2 );
2251 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
2252 append( sb, "Expression: ${docfilessubdirs}", 3 );
2253 append( sb, "", 0 );
2254
2255 append( sb, "doclet", 2 );
2256 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
2257 append( sb, "Expression: ${doclet}", 3 );
2258 append( sb, "", 0 );
2259
2260 append( sb, "docletArtifact", 2 );
2261 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 );
2262 append( sb, "Expression: ${docletArtifact}", 3 );
2263 append( sb, "", 0 );
2264
2265 append( sb, "docletArtifacts", 2 );
2266 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 );
2267 append( sb, "Expression: ${docletArtifacts}", 3 );
2268 append( sb, "", 0 );
2269
2270 append( sb, "docletPath", 2 );
2271 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
2272 append( sb, "Expression: ${docletPath}", 3 );
2273 append( sb, "", 0 );
2274
2275 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
2276 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
2277 append( sb, "Expression: ${doctitle}", 3 );
2278 append( sb, "", 0 );
2279
2280 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
2281 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 );
2282 append( sb, "Expression: ${encoding}", 3 );
2283 append( sb, "", 0 );
2284
2285 append( sb, "excludedocfilessubdir", 2 );
2286 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 );
2287 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
2288 append( sb, "", 0 );
2289
2290 append( sb, "excludePackageNames", 2 );
2291 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
2292 append( sb, "Expression: ${excludePackageNames}", 3 );
2293 append( sb, "", 0 );
2294
2295 append( sb, "extdirs", 2 );
2296 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
2297 append( sb, "Expression: ${extdirs}", 3 );
2298 append( sb, "", 0 );
2299
2300 append( sb, "failOnError (Default: true)", 2 );
2301 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
2302 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
2303 append( sb, "", 0 );
2304
2305 append( sb, "footer", 2 );
2306 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
2307 append( sb, "Expression: ${footer}", 3 );
2308 append( sb, "", 0 );
2309
2310 append( sb, "groups", 2 );
2311 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
2312 append( sb, "Expression: ${groups}", 3 );
2313 append( sb, "", 0 );
2314
2315 append( sb, "header", 2 );
2316 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
2317 append( sb, "Expression: ${header}", 3 );
2318 append( sb, "", 0 );
2319
2320 append( sb, "helpfile", 2 );
2321 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
2322 append( sb, "Expression: ${helpfile}", 3 );
2323 append( sb, "", 0 );
2324
2325 append( sb, "includeDependencySources (Default: false)", 2 );
2326 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
2327 append( sb, "", 0 );
2328
2329 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
2330 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
2331 append( sb, "", 0 );
2332
2333 append( sb, "javaApiLinks", 2 );
2334 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
2335 append( sb, "Expression: ${javaApiLinks}", 3 );
2336 append( sb, "", 0 );
2337
2338 append( sb, "javadocDirectory", 2 );
2339 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 );
2340 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
2341 append( sb, "", 0 );
2342
2343 append( sb, "javadocExecutable", 2 );
2344 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 );
2345 append( sb, "Expression: ${javadocExecutable}", 3 );
2346 append( sb, "", 0 );
2347
2348 append( sb, "javadocVersion", 2 );
2349 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
2350 append( sb, "Expression: ${javadocVersion}", 3 );
2351 append( sb, "", 0 );
2352
2353 append( sb, "keywords (Default: false)", 2 );
2354 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 );
2355 append( sb, "Expression: ${keywords}", 3 );
2356 append( sb, "", 0 );
2357
2358 append( sb, "links", 2 );
2359 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
2360 append( sb, "Expression: ${links}", 3 );
2361 append( sb, "", 0 );
2362
2363 append( sb, "linksource (Default: false)", 2 );
2364 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 );
2365 append( sb, "Expression: ${linksource}", 3 );
2366 append( sb, "", 0 );
2367
2368 append( sb, "locale", 2 );
2369 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
2370 append( sb, "Expression: ${locale}", 3 );
2371 append( sb, "", 0 );
2372
2373 append( sb, "localRepository", 2 );
2374 append( sb, "The local repository where the artifacts are located.", 3 );
2375 append( sb, "Expression: ${localRepository}", 3 );
2376 append( sb, "", 0 );
2377
2378 append( sb, "maxmemory", 2 );
2379 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 );
2380 append( sb, "Expression: ${maxmemory}", 3 );
2381 append( sb, "", 0 );
2382
2383 append( sb, "minmemory", 2 );
2384 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 );
2385 append( sb, "Expression: ${minmemory}", 3 );
2386 append( sb, "", 0 );
2387
2388 append( sb, "nocomment (Default: false)", 2 );
2389 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 );
2390 append( sb, "Expression: ${nocomment}", 3 );
2391 append( sb, "", 0 );
2392
2393 append( sb, "nodeprecated (Default: false)", 2 );
2394 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
2395 append( sb, "Expression: ${nodeprecated}", 3 );
2396 append( sb, "", 0 );
2397
2398 append( sb, "nodeprecatedlist (Default: false)", 2 );
2399 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 );
2400 append( sb, "Expression: ${nodeprecatedlist}", 3 );
2401 append( sb, "", 0 );
2402
2403 append( sb, "nohelp (Default: false)", 2 );
2404 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 );
2405 append( sb, "Expression: ${nohelp}", 3 );
2406 append( sb, "", 0 );
2407
2408 append( sb, "noindex (Default: false)", 2 );
2409 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
2410 append( sb, "Expression: ${noindex}", 3 );
2411 append( sb, "", 0 );
2412
2413 append( sb, "nonavbar (Default: false)", 2 );
2414 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
2415 append( sb, "Expression: ${nonavbar}", 3 );
2416 append( sb, "", 0 );
2417
2418 append( sb, "nooverview (Default: false)", 2 );
2419 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
2420 append( sb, "Expression: ${nooverview}", 3 );
2421 append( sb, "", 0 );
2422
2423 append( sb, "noqualifier", 2 );
2424 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
2425 append( sb, "Expression: ${noqualifier}", 3 );
2426 append( sb, "", 0 );
2427
2428 append( sb, "nosince (Default: false)", 2 );
2429 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
2430 append( sb, "Expression: ${nosince}", 3 );
2431 append( sb, "", 0 );
2432
2433 append( sb, "notimestamp (Default: false)", 2 );
2434 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 );
2435 append( sb, "Expression: ${notimestamp}", 3 );
2436 append( sb, "", 0 );
2437
2438 append( sb, "notree (Default: false)", 2 );
2439 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
2440 append( sb, "Expression: ${notree}", 3 );
2441 append( sb, "", 0 );
2442
2443 append( sb, "offlineLinks", 2 );
2444 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
2445 append( sb, "Expression: ${offlineLinks}", 3 );
2446 append( sb, "", 0 );
2447
2448 append( sb, "old (Default: false)", 2 );
2449 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
2450 append( sb, "Expression: ${old}", 3 );
2451 append( sb, "", 0 );
2452
2453 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
2454 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
2455 append( sb, "Required: Yes", 3 );
2456 append( sb, "Expression: ${destDir}", 3 );
2457 append( sb, "", 0 );
2458
2459 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
2460 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 );
2461 append( sb, "Expression: ${overview}", 3 );
2462 append( sb, "", 0 );
2463
2464 append( sb, "packagesheader", 2 );
2465 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
2466 append( sb, "Expression: ${packagesheader}", 3 );
2467 append( sb, "", 0 );
2468
2469 append( sb, "proxyHost", 2 );
2470 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
2471 append( sb, "", 0 );
2472 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 );
2473 append( sb, "Expression: ${proxyHost}", 3 );
2474 append( sb, "", 0 );
2475
2476 append( sb, "proxyPort", 2 );
2477 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
2478 append( sb, "", 0 );
2479 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 );
2480 append( sb, "Expression: ${proxyPort}", 3 );
2481 append( sb, "", 0 );
2482
2483 append( sb, "quiet (Default: false)", 2 );
2484 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 );
2485 append( sb, "Expression: ${quiet}", 3 );
2486 append( sb, "", 0 );
2487
2488 append( sb, "remoteRepositories", 2 );
2489 append( sb, "The remote repositories where artifacts are located.", 3 );
2490 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2491 append( sb, "", 0 );
2492
2493 append( sb, "resourcesArtifacts", 2 );
2494 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 );
2495 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2496 append( sb, "", 0 );
2497
2498 append( sb, "serialwarn (Default: false)", 2 );
2499 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2500 append( sb, "Expression: ${serialwarn}", 3 );
2501 append( sb, "", 0 );
2502
2503 append( sb, "show (Default: protected)", 2 );
2504 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 );
2505 append( sb, "Expression: ${show}", 3 );
2506 append( sb, "", 0 );
2507
2508 append( sb, "skip (Default: false)", 2 );
2509 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2510 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2511 append( sb, "", 0 );
2512
2513 append( sb, "source", 2 );
2514 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
2515 append( sb, "Expression: ${source}", 3 );
2516 append( sb, "", 0 );
2517
2518 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
2519 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
2520 append( sb, "", 0 );
2521
2522 append( sb, "sourcepath", 2 );
2523 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
2524 append( sb, "Expression: ${sourcepath}", 3 );
2525 append( sb, "", 0 );
2526
2527 append( sb, "sourcetab", 2 );
2528 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 );
2529 append( sb, "Expression: ${sourcetab}", 3 );
2530 append( sb, "", 0 );
2531
2532 append( sb, "splitindex (Default: false)", 2 );
2533 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 );
2534 append( sb, "Expression: ${splitindex}", 3 );
2535 append( sb, "", 0 );
2536
2537 append( sb, "stylesheet (Default: java)", 2 );
2538 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
2539 append( sb, "Expression: ${stylesheet}", 3 );
2540 append( sb, "", 0 );
2541
2542 append( sb, "stylesheetfile", 2 );
2543 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
2544 append( sb, "Expression: ${stylesheetfile}", 3 );
2545 append( sb, "", 0 );
2546
2547 append( sb, "subpackages", 2 );
2548 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 );
2549 append( sb, "Expression: ${subpackages}", 3 );
2550 append( sb, "", 0 );
2551
2552 append( sb, "taglet", 2 );
2553 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 );
2554 append( sb, "Expression: ${taglet}", 3 );
2555 append( sb, "", 0 );
2556
2557 append( sb, "tagletArtifact", 2 );
2558 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 );
2559 append( sb, "Expression: ${tagletArtifact}", 3 );
2560 append( sb, "", 0 );
2561
2562 append( sb, "tagletArtifacts", 2 );
2563 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 );
2564 append( sb, "Expression: ${tagletArtifacts}", 3 );
2565 append( sb, "", 0 );
2566
2567 append( sb, "tagletpath", 2 );
2568 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
2569 append( sb, "Expression: ${tagletpath}", 3 );
2570 append( sb, "", 0 );
2571
2572 append( sb, "taglets", 2 );
2573 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 );
2574 append( sb, "Expression: ${taglets}", 3 );
2575 append( sb, "", 0 );
2576
2577 append( sb, "tags", 2 );
2578 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
2579 append( sb, "Expression: ${tags}", 3 );
2580 append( sb, "", 0 );
2581
2582 append( sb, "top", 2 );
2583 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
2584 append( sb, "Expression: ${top}", 3 );
2585 append( sb, "", 0 );
2586
2587 append( sb, "use (Default: true)", 2 );
2588 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
2589 append( sb, "Expression: ${use}", 3 );
2590 append( sb, "", 0 );
2591
2592 append( sb, "useStandardDocletOptions (Default: true)", 2 );
2593 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 );
2594 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
2595 append( sb, "", 0 );
2596
2597 append( sb, "validateLinks (Default: false)", 2 );
2598 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
2599 append( sb, "Expression: ${validateLinks}", 3 );
2600 append( sb, "", 0 );
2601
2602 append( sb, "verbose (Default: false)", 2 );
2603 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
2604 append( sb, "Expression: ${verbose}", 3 );
2605 append( sb, "", 0 );
2606
2607 append( sb, "version (Default: true)", 2 );
2608 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
2609 append( sb, "Expression: ${version}", 3 );
2610 append( sb, "", 0 );
2611
2612 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
2613 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
2614 append( sb, "Expression: ${windowtitle}", 3 );
2615 append( sb, "", 0 );
2616 }
2617 }
2618
2619 if ( goal == null || goal.length() <= 0 || "test-aggregate".equals( goal ) )
2620 {
2621 append( sb, "javadoc:test-aggregate", 0 );
2622 append( sb, "Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.", 1 );
2623 append( sb, "", 0 );
2624 if ( detail )
2625 {
2626 append( sb, "Available parameters:", 1 );
2627 append( sb, "", 0 );
2628
2629 append( sb, "additionalJOption", 2 );
2630 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
2631 append( sb, "Expression: ${additionalJOption}", 3 );
2632 append( sb, "", 0 );
2633
2634 append( sb, "additionalparam", 2 );
2635 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 );
2636 append( sb, "Expression: ${additionalparam}", 3 );
2637 append( sb, "", 0 );
2638
2639 append( sb, "additionnalDependencies", 2 );
2640 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
2641 append( sb, "", 0 );
2642
2643 append( sb, "aggregate (Default: false)", 2 );
2644 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
2645 append( sb, "", 0 );
2646 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
2647 append( sb, "Expression: ${aggregate}", 3 );
2648 append( sb, "", 0 );
2649
2650 append( sb, "author (Default: true)", 2 );
2651 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
2652 append( sb, "Expression: ${author}", 3 );
2653 append( sb, "", 0 );
2654
2655 append( sb, "bootclasspath", 2 );
2656 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
2657 append( sb, "Expression: ${bootclasspath}", 3 );
2658 append( sb, "", 0 );
2659
2660 append( sb, "bootclasspathArtifacts", 2 );
2661 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 );
2662 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
2663 append( sb, "", 0 );
2664
2665 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
2666 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 );
2667 append( sb, "Expression: ${bottom}", 3 );
2668 append( sb, "", 0 );
2669
2670 append( sb, "breakiterator (Default: false)", 2 );
2671 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
2672 append( sb, "Expression: ${breakiterator}", 3 );
2673 append( sb, "", 0 );
2674
2675 append( sb, "charset", 2 );
2676 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 );
2677 append( sb, "Expression: ${charset}", 3 );
2678 append( sb, "", 0 );
2679
2680 append( sb, "debug (Default: false)", 2 );
2681 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
2682 append( sb, "Expression: ${debug}", 3 );
2683 append( sb, "", 0 );
2684
2685 append( sb, "dependencySourceExcludes", 2 );
2686 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
2687 append( sb, "", 0 );
2688
2689 append( sb, "dependencySourceIncludes", 2 );
2690 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
2691 append( sb, "", 0 );
2692
2693 append( sb, "description", 2 );
2694 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
2695 append( sb, "Expression: ${description}", 3 );
2696 append( sb, "", 0 );
2697
2698 append( sb, "destDir (Default: testapidocs)", 2 );
2699 append( sb, "The name of the destination directory.\n", 3 );
2700 append( sb, "Expression: ${destDir}", 3 );
2701 append( sb, "", 0 );
2702
2703 append( sb, "detectJavaApiLink (Default: true)", 2 );
2704 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
2705 append( sb, "Expression: ${detectJavaApiLink}", 3 );
2706 append( sb, "", 0 );
2707
2708 append( sb, "detectLinks (Default: false)", 2 );
2709 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
2710 append( sb, "Expression: ${detectLinks}", 3 );
2711 append( sb, "", 0 );
2712
2713 append( sb, "detectOfflineLinks (Default: true)", 2 );
2714 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
2715 append( sb, "Expression: ${detectOfflineLinks}", 3 );
2716 append( sb, "", 0 );
2717
2718 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
2719 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
2720 append( sb, "Expression: ${docencoding}", 3 );
2721 append( sb, "", 0 );
2722
2723 append( sb, "docfilessubdirs (Default: false)", 2 );
2724 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
2725 append( sb, "Expression: ${docfilessubdirs}", 3 );
2726 append( sb, "", 0 );
2727
2728 append( sb, "doclet", 2 );
2729 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
2730 append( sb, "Expression: ${doclet}", 3 );
2731 append( sb, "", 0 );
2732
2733 append( sb, "docletArtifact", 2 );
2734 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 );
2735 append( sb, "Expression: ${docletArtifact}", 3 );
2736 append( sb, "", 0 );
2737
2738 append( sb, "docletArtifacts", 2 );
2739 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 );
2740 append( sb, "Expression: ${docletArtifacts}", 3 );
2741 append( sb, "", 0 );
2742
2743 append( sb, "docletPath", 2 );
2744 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
2745 append( sb, "Expression: ${docletPath}", 3 );
2746 append( sb, "", 0 );
2747
2748 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
2749 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
2750 append( sb, "Expression: ${doctitle}", 3 );
2751 append( sb, "", 0 );
2752
2753 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
2754 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 );
2755 append( sb, "Expression: ${encoding}", 3 );
2756 append( sb, "", 0 );
2757
2758 append( sb, "excludedocfilessubdir", 2 );
2759 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 );
2760 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
2761 append( sb, "", 0 );
2762
2763 append( sb, "excludePackageNames", 2 );
2764 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
2765 append( sb, "Expression: ${excludePackageNames}", 3 );
2766 append( sb, "", 0 );
2767
2768 append( sb, "extdirs", 2 );
2769 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
2770 append( sb, "Expression: ${extdirs}", 3 );
2771 append( sb, "", 0 );
2772
2773 append( sb, "failOnError (Default: true)", 2 );
2774 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
2775 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
2776 append( sb, "", 0 );
2777
2778 append( sb, "footer", 2 );
2779 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
2780 append( sb, "Expression: ${footer}", 3 );
2781 append( sb, "", 0 );
2782
2783 append( sb, "groups", 2 );
2784 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
2785 append( sb, "Expression: ${groups}", 3 );
2786 append( sb, "", 0 );
2787
2788 append( sb, "header", 2 );
2789 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
2790 append( sb, "Expression: ${header}", 3 );
2791 append( sb, "", 0 );
2792
2793 append( sb, "helpfile", 2 );
2794 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
2795 append( sb, "Expression: ${helpfile}", 3 );
2796 append( sb, "", 0 );
2797
2798 append( sb, "includeDependencySources (Default: false)", 2 );
2799 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
2800 append( sb, "", 0 );
2801
2802 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
2803 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
2804 append( sb, "", 0 );
2805
2806 append( sb, "javaApiLinks", 2 );
2807 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
2808 append( sb, "Expression: ${javaApiLinks}", 3 );
2809 append( sb, "", 0 );
2810
2811 append( sb, "javadocDirectory", 2 );
2812 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 );
2813 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
2814 append( sb, "", 0 );
2815
2816 append( sb, "javadocExecutable", 2 );
2817 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 );
2818 append( sb, "Expression: ${javadocExecutable}", 3 );
2819 append( sb, "", 0 );
2820
2821 append( sb, "javadocVersion", 2 );
2822 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
2823 append( sb, "Expression: ${javadocVersion}", 3 );
2824 append( sb, "", 0 );
2825
2826 append( sb, "keywords (Default: false)", 2 );
2827 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 );
2828 append( sb, "Expression: ${keywords}", 3 );
2829 append( sb, "", 0 );
2830
2831 append( sb, "links", 2 );
2832 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
2833 append( sb, "Expression: ${links}", 3 );
2834 append( sb, "", 0 );
2835
2836 append( sb, "linksource (Default: false)", 2 );
2837 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 );
2838 append( sb, "Expression: ${linksource}", 3 );
2839 append( sb, "", 0 );
2840
2841 append( sb, "locale", 2 );
2842 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
2843 append( sb, "Expression: ${locale}", 3 );
2844 append( sb, "", 0 );
2845
2846 append( sb, "localRepository", 2 );
2847 append( sb, "The local repository where the artifacts are located.", 3 );
2848 append( sb, "Expression: ${localRepository}", 3 );
2849 append( sb, "", 0 );
2850
2851 append( sb, "maxmemory", 2 );
2852 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 );
2853 append( sb, "Expression: ${maxmemory}", 3 );
2854 append( sb, "", 0 );
2855
2856 append( sb, "minmemory", 2 );
2857 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 );
2858 append( sb, "Expression: ${minmemory}", 3 );
2859 append( sb, "", 0 );
2860
2861 append( sb, "name", 2 );
2862 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
2863 append( sb, "Expression: ${name}", 3 );
2864 append( sb, "", 0 );
2865
2866 append( sb, "nocomment (Default: false)", 2 );
2867 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 );
2868 append( sb, "Expression: ${nocomment}", 3 );
2869 append( sb, "", 0 );
2870
2871 append( sb, "nodeprecated (Default: false)", 2 );
2872 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
2873 append( sb, "Expression: ${nodeprecated}", 3 );
2874 append( sb, "", 0 );
2875
2876 append( sb, "nodeprecatedlist (Default: false)", 2 );
2877 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 );
2878 append( sb, "Expression: ${nodeprecatedlist}", 3 );
2879 append( sb, "", 0 );
2880
2881 append( sb, "nohelp (Default: false)", 2 );
2882 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 );
2883 append( sb, "Expression: ${nohelp}", 3 );
2884 append( sb, "", 0 );
2885
2886 append( sb, "noindex (Default: false)", 2 );
2887 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
2888 append( sb, "Expression: ${noindex}", 3 );
2889 append( sb, "", 0 );
2890
2891 append( sb, "nonavbar (Default: false)", 2 );
2892 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
2893 append( sb, "Expression: ${nonavbar}", 3 );
2894 append( sb, "", 0 );
2895
2896 append( sb, "nooverview (Default: false)", 2 );
2897 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
2898 append( sb, "Expression: ${nooverview}", 3 );
2899 append( sb, "", 0 );
2900
2901 append( sb, "noqualifier", 2 );
2902 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
2903 append( sb, "Expression: ${noqualifier}", 3 );
2904 append( sb, "", 0 );
2905
2906 append( sb, "nosince (Default: false)", 2 );
2907 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
2908 append( sb, "Expression: ${nosince}", 3 );
2909 append( sb, "", 0 );
2910
2911 append( sb, "notimestamp (Default: false)", 2 );
2912 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 );
2913 append( sb, "Expression: ${notimestamp}", 3 );
2914 append( sb, "", 0 );
2915
2916 append( sb, "notree (Default: false)", 2 );
2917 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
2918 append( sb, "Expression: ${notree}", 3 );
2919 append( sb, "", 0 );
2920
2921 append( sb, "offlineLinks", 2 );
2922 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
2923 append( sb, "Expression: ${offlineLinks}", 3 );
2924 append( sb, "", 0 );
2925
2926 append( sb, "old (Default: false)", 2 );
2927 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
2928 append( sb, "Expression: ${old}", 3 );
2929 append( sb, "", 0 );
2930
2931 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
2932 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
2933 append( sb, "Required: Yes", 3 );
2934 append( sb, "Expression: ${destDir}", 3 );
2935 append( sb, "", 0 );
2936
2937 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
2938 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 );
2939 append( sb, "Expression: ${overview}", 3 );
2940 append( sb, "", 0 );
2941
2942 append( sb, "packagesheader", 2 );
2943 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
2944 append( sb, "Expression: ${packagesheader}", 3 );
2945 append( sb, "", 0 );
2946
2947 append( sb, "proxyHost", 2 );
2948 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
2949 append( sb, "", 0 );
2950 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 );
2951 append( sb, "Expression: ${proxyHost}", 3 );
2952 append( sb, "", 0 );
2953
2954 append( sb, "proxyPort", 2 );
2955 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
2956 append( sb, "", 0 );
2957 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 );
2958 append( sb, "Expression: ${proxyPort}", 3 );
2959 append( sb, "", 0 );
2960
2961 append( sb, "quiet (Default: false)", 2 );
2962 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 );
2963 append( sb, "Expression: ${quiet}", 3 );
2964 append( sb, "", 0 );
2965
2966 append( sb, "remoteRepositories", 2 );
2967 append( sb, "The remote repositories where artifacts are located.", 3 );
2968 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2969 append( sb, "", 0 );
2970
2971 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
2972 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
2973 append( sb, "Required: Yes", 3 );
2974 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
2975 append( sb, "", 0 );
2976
2977 append( sb, "resourcesArtifacts", 2 );
2978 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 );
2979 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2980 append( sb, "", 0 );
2981
2982 append( sb, "serialwarn (Default: false)", 2 );
2983 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2984 append( sb, "Expression: ${serialwarn}", 3 );
2985 append( sb, "", 0 );
2986
2987 append( sb, "show (Default: protected)", 2 );
2988 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 );
2989 append( sb, "Expression: ${show}", 3 );
2990 append( sb, "", 0 );
2991
2992 append( sb, "skip (Default: false)", 2 );
2993 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2994 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2995 append( sb, "", 0 );
2996
2997 append( sb, "source", 2 );
2998 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
2999 append( sb, "Expression: ${source}", 3 );
3000 append( sb, "", 0 );
3001
3002 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
3003 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
3004 append( sb, "", 0 );
3005
3006 append( sb, "sourcepath", 2 );
3007 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
3008 append( sb, "Expression: ${sourcepath}", 3 );
3009 append( sb, "", 0 );
3010
3011 append( sb, "sourcetab", 2 );
3012 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 );
3013 append( sb, "Expression: ${sourcetab}", 3 );
3014 append( sb, "", 0 );
3015
3016 append( sb, "splitindex (Default: false)", 2 );
3017 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 );
3018 append( sb, "Expression: ${splitindex}", 3 );
3019 append( sb, "", 0 );
3020
3021 append( sb, "stylesheet (Default: java)", 2 );
3022 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
3023 append( sb, "Expression: ${stylesheet}", 3 );
3024 append( sb, "", 0 );
3025
3026 append( sb, "stylesheetfile", 2 );
3027 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
3028 append( sb, "Expression: ${stylesheetfile}", 3 );
3029 append( sb, "", 0 );
3030
3031 append( sb, "subpackages", 2 );
3032 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 );
3033 append( sb, "Expression: ${subpackages}", 3 );
3034 append( sb, "", 0 );
3035
3036 append( sb, "taglet", 2 );
3037 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 );
3038 append( sb, "Expression: ${taglet}", 3 );
3039 append( sb, "", 0 );
3040
3041 append( sb, "tagletArtifact", 2 );
3042 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 );
3043 append( sb, "Expression: ${tagletArtifact}", 3 );
3044 append( sb, "", 0 );
3045
3046 append( sb, "tagletArtifacts", 2 );
3047 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 );
3048 append( sb, "Expression: ${tagletArtifacts}", 3 );
3049 append( sb, "", 0 );
3050
3051 append( sb, "tagletpath", 2 );
3052 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
3053 append( sb, "Expression: ${tagletpath}", 3 );
3054 append( sb, "", 0 );
3055
3056 append( sb, "taglets", 2 );
3057 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 );
3058 append( sb, "Expression: ${taglets}", 3 );
3059 append( sb, "", 0 );
3060
3061 append( sb, "tags", 2 );
3062 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
3063 append( sb, "Expression: ${tags}", 3 );
3064 append( sb, "", 0 );
3065
3066 append( sb, "testDescription", 2 );
3067 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
3068 append( sb, "Expression: ${testDescription}", 3 );
3069 append( sb, "", 0 );
3070
3071 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
3072 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3073 append( sb, "Expression: ${testDoctitle}", 3 );
3074 append( sb, "", 0 );
3075
3076 append( sb, "testJavadocDirectory", 2 );
3077 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
3078 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
3079 append( sb, "", 0 );
3080
3081 append( sb, "testName", 2 );
3082 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
3083 append( sb, "Expression: ${testName}", 3 );
3084 append( sb, "", 0 );
3085
3086 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
3087 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
3088 append( sb, "Expression: ${testOverview}", 3 );
3089 append( sb, "", 0 );
3090
3091 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
3092 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3093 append( sb, "Expression: ${testWindowtitle}", 3 );
3094 append( sb, "", 0 );
3095
3096 append( sb, "top", 2 );
3097 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
3098 append( sb, "Expression: ${top}", 3 );
3099 append( sb, "", 0 );
3100
3101 append( sb, "use (Default: true)", 2 );
3102 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
3103 append( sb, "Expression: ${use}", 3 );
3104 append( sb, "", 0 );
3105
3106 append( sb, "useStandardDocletOptions (Default: true)", 2 );
3107 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 );
3108 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
3109 append( sb, "", 0 );
3110
3111 append( sb, "validateLinks (Default: false)", 2 );
3112 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
3113 append( sb, "Expression: ${validateLinks}", 3 );
3114 append( sb, "", 0 );
3115
3116 append( sb, "verbose (Default: false)", 2 );
3117 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
3118 append( sb, "Expression: ${verbose}", 3 );
3119 append( sb, "", 0 );
3120
3121 append( sb, "version (Default: true)", 2 );
3122 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
3123 append( sb, "Expression: ${version}", 3 );
3124 append( sb, "", 0 );
3125
3126 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
3127 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3128 append( sb, "Expression: ${windowtitle}", 3 );
3129 append( sb, "", 0 );
3130 }
3131 }
3132
3133 if ( goal == null || goal.length() <= 0 || "test-aggregate-jar".equals( goal ) )
3134 {
3135 append( sb, "javadoc:test-aggregate-jar", 0 );
3136 append( sb, "Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
3137 append( sb, "", 0 );
3138 if ( detail )
3139 {
3140 append( sb, "Available parameters:", 1 );
3141 append( sb, "", 0 );
3142
3143 append( sb, "additionalJOption", 2 );
3144 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
3145 append( sb, "Expression: ${additionalJOption}", 3 );
3146 append( sb, "", 0 );
3147
3148 append( sb, "additionalparam", 2 );
3149 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 );
3150 append( sb, "Expression: ${additionalparam}", 3 );
3151 append( sb, "", 0 );
3152
3153 append( sb, "additionnalDependencies", 2 );
3154 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
3155 append( sb, "", 0 );
3156
3157 append( sb, "aggregate (Default: false)", 2 );
3158 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
3159 append( sb, "", 0 );
3160 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
3161 append( sb, "Expression: ${aggregate}", 3 );
3162 append( sb, "", 0 );
3163
3164 append( sb, "archive", 2 );
3165 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
3166 append( sb, "", 0 );
3167
3168 append( sb, "attach (Default: true)", 2 );
3169 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
3170 append( sb, "Expression: ${attach}", 3 );
3171 append( sb, "", 0 );
3172
3173 append( sb, "author (Default: true)", 2 );
3174 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
3175 append( sb, "Expression: ${author}", 3 );
3176 append( sb, "", 0 );
3177
3178 append( sb, "bootclasspath", 2 );
3179 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
3180 append( sb, "Expression: ${bootclasspath}", 3 );
3181 append( sb, "", 0 );
3182
3183 append( sb, "bootclasspathArtifacts", 2 );
3184 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 );
3185 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
3186 append( sb, "", 0 );
3187
3188 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
3189 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 );
3190 append( sb, "Expression: ${bottom}", 3 );
3191 append( sb, "", 0 );
3192
3193 append( sb, "breakiterator (Default: false)", 2 );
3194 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
3195 append( sb, "Expression: ${breakiterator}", 3 );
3196 append( sb, "", 0 );
3197
3198 append( sb, "charset", 2 );
3199 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 );
3200 append( sb, "Expression: ${charset}", 3 );
3201 append( sb, "", 0 );
3202
3203 append( sb, "debug (Default: false)", 2 );
3204 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
3205 append( sb, "Expression: ${debug}", 3 );
3206 append( sb, "", 0 );
3207
3208 append( sb, "dependencySourceExcludes", 2 );
3209 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
3210 append( sb, "", 0 );
3211
3212 append( sb, "dependencySourceIncludes", 2 );
3213 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
3214 append( sb, "", 0 );
3215
3216 append( sb, "destDir", 2 );
3217 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
3218 append( sb, "Expression: ${destDir}", 3 );
3219 append( sb, "", 0 );
3220
3221 append( sb, "detectJavaApiLink (Default: true)", 2 );
3222 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
3223 append( sb, "Expression: ${detectJavaApiLink}", 3 );
3224 append( sb, "", 0 );
3225
3226 append( sb, "detectLinks (Default: false)", 2 );
3227 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
3228 append( sb, "Expression: ${detectLinks}", 3 );
3229 append( sb, "", 0 );
3230
3231 append( sb, "detectOfflineLinks (Default: true)", 2 );
3232 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
3233 append( sb, "Expression: ${detectOfflineLinks}", 3 );
3234 append( sb, "", 0 );
3235
3236 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
3237 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
3238 append( sb, "Expression: ${docencoding}", 3 );
3239 append( sb, "", 0 );
3240
3241 append( sb, "docfilessubdirs (Default: false)", 2 );
3242 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
3243 append( sb, "Expression: ${docfilessubdirs}", 3 );
3244 append( sb, "", 0 );
3245
3246 append( sb, "doclet", 2 );
3247 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
3248 append( sb, "Expression: ${doclet}", 3 );
3249 append( sb, "", 0 );
3250
3251 append( sb, "docletArtifact", 2 );
3252 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 );
3253 append( sb, "Expression: ${docletArtifact}", 3 );
3254 append( sb, "", 0 );
3255
3256 append( sb, "docletArtifacts", 2 );
3257 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 );
3258 append( sb, "Expression: ${docletArtifacts}", 3 );
3259 append( sb, "", 0 );
3260
3261 append( sb, "docletPath", 2 );
3262 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
3263 append( sb, "Expression: ${docletPath}", 3 );
3264 append( sb, "", 0 );
3265
3266 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
3267 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3268 append( sb, "Expression: ${doctitle}", 3 );
3269 append( sb, "", 0 );
3270
3271 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3272 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 );
3273 append( sb, "Expression: ${encoding}", 3 );
3274 append( sb, "", 0 );
3275
3276 append( sb, "excludedocfilessubdir", 2 );
3277 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 );
3278 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
3279 append( sb, "", 0 );
3280
3281 append( sb, "excludePackageNames", 2 );
3282 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
3283 append( sb, "Expression: ${excludePackageNames}", 3 );
3284 append( sb, "", 0 );
3285
3286 append( sb, "extdirs", 2 );
3287 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
3288 append( sb, "Expression: ${extdirs}", 3 );
3289 append( sb, "", 0 );
3290
3291 append( sb, "failOnError (Default: true)", 2 );
3292 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
3293 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
3294 append( sb, "", 0 );
3295
3296 append( sb, "finalName", 2 );
3297 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 );
3298 append( sb, "Expression: ${project.build.finalName}", 3 );
3299 append( sb, "", 0 );
3300
3301 append( sb, "footer", 2 );
3302 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
3303 append( sb, "Expression: ${footer}", 3 );
3304 append( sb, "", 0 );
3305
3306 append( sb, "groups", 2 );
3307 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
3308 append( sb, "Expression: ${groups}", 3 );
3309 append( sb, "", 0 );
3310
3311 append( sb, "header", 2 );
3312 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
3313 append( sb, "Expression: ${header}", 3 );
3314 append( sb, "", 0 );
3315
3316 append( sb, "helpfile", 2 );
3317 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
3318 append( sb, "Expression: ${helpfile}", 3 );
3319 append( sb, "", 0 );
3320
3321 append( sb, "includeDependencySources (Default: false)", 2 );
3322 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
3323 append( sb, "", 0 );
3324
3325 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
3326 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
3327 append( sb, "", 0 );
3328
3329 append( sb, "jarOutputDirectory", 2 );
3330 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
3331 append( sb, "Expression: ${project.build.directory}", 3 );
3332 append( sb, "", 0 );
3333
3334 append( sb, "javaApiLinks", 2 );
3335 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
3336 append( sb, "Expression: ${javaApiLinks}", 3 );
3337 append( sb, "", 0 );
3338
3339 append( sb, "javadocDirectory", 2 );
3340 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 );
3341 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
3342 append( sb, "", 0 );
3343
3344 append( sb, "javadocExecutable", 2 );
3345 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 );
3346 append( sb, "Expression: ${javadocExecutable}", 3 );
3347 append( sb, "", 0 );
3348
3349 append( sb, "javadocVersion", 2 );
3350 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
3351 append( sb, "Expression: ${javadocVersion}", 3 );
3352 append( sb, "", 0 );
3353
3354 append( sb, "keywords (Default: false)", 2 );
3355 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 );
3356 append( sb, "Expression: ${keywords}", 3 );
3357 append( sb, "", 0 );
3358
3359 append( sb, "links", 2 );
3360 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
3361 append( sb, "Expression: ${links}", 3 );
3362 append( sb, "", 0 );
3363
3364 append( sb, "linksource (Default: false)", 2 );
3365 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 );
3366 append( sb, "Expression: ${linksource}", 3 );
3367 append( sb, "", 0 );
3368
3369 append( sb, "locale", 2 );
3370 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
3371 append( sb, "Expression: ${locale}", 3 );
3372 append( sb, "", 0 );
3373
3374 append( sb, "localRepository", 2 );
3375 append( sb, "The local repository where the artifacts are located.", 3 );
3376 append( sb, "Expression: ${localRepository}", 3 );
3377 append( sb, "", 0 );
3378
3379 append( sb, "maxmemory", 2 );
3380 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 );
3381 append( sb, "Expression: ${maxmemory}", 3 );
3382 append( sb, "", 0 );
3383
3384 append( sb, "minmemory", 2 );
3385 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 );
3386 append( sb, "Expression: ${minmemory}", 3 );
3387 append( sb, "", 0 );
3388
3389 append( sb, "nocomment (Default: false)", 2 );
3390 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 );
3391 append( sb, "Expression: ${nocomment}", 3 );
3392 append( sb, "", 0 );
3393
3394 append( sb, "nodeprecated (Default: false)", 2 );
3395 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
3396 append( sb, "Expression: ${nodeprecated}", 3 );
3397 append( sb, "", 0 );
3398
3399 append( sb, "nodeprecatedlist (Default: false)", 2 );
3400 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 );
3401 append( sb, "Expression: ${nodeprecatedlist}", 3 );
3402 append( sb, "", 0 );
3403
3404 append( sb, "nohelp (Default: false)", 2 );
3405 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 );
3406 append( sb, "Expression: ${nohelp}", 3 );
3407 append( sb, "", 0 );
3408
3409 append( sb, "noindex (Default: false)", 2 );
3410 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
3411 append( sb, "Expression: ${noindex}", 3 );
3412 append( sb, "", 0 );
3413
3414 append( sb, "nonavbar (Default: false)", 2 );
3415 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
3416 append( sb, "Expression: ${nonavbar}", 3 );
3417 append( sb, "", 0 );
3418
3419 append( sb, "nooverview (Default: false)", 2 );
3420 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
3421 append( sb, "Expression: ${nooverview}", 3 );
3422 append( sb, "", 0 );
3423
3424 append( sb, "noqualifier", 2 );
3425 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
3426 append( sb, "Expression: ${noqualifier}", 3 );
3427 append( sb, "", 0 );
3428
3429 append( sb, "nosince (Default: false)", 2 );
3430 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
3431 append( sb, "Expression: ${nosince}", 3 );
3432 append( sb, "", 0 );
3433
3434 append( sb, "notimestamp (Default: false)", 2 );
3435 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 );
3436 append( sb, "Expression: ${notimestamp}", 3 );
3437 append( sb, "", 0 );
3438
3439 append( sb, "notree (Default: false)", 2 );
3440 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
3441 append( sb, "Expression: ${notree}", 3 );
3442 append( sb, "", 0 );
3443
3444 append( sb, "offlineLinks", 2 );
3445 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
3446 append( sb, "Expression: ${offlineLinks}", 3 );
3447 append( sb, "", 0 );
3448
3449 append( sb, "old (Default: false)", 2 );
3450 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
3451 append( sb, "Expression: ${old}", 3 );
3452 append( sb, "", 0 );
3453
3454 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
3455 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
3456 append( sb, "Required: Yes", 3 );
3457 append( sb, "", 0 );
3458
3459 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
3460 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 );
3461 append( sb, "Expression: ${overview}", 3 );
3462 append( sb, "", 0 );
3463
3464 append( sb, "packagesheader", 2 );
3465 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
3466 append( sb, "Expression: ${packagesheader}", 3 );
3467 append( sb, "", 0 );
3468
3469 append( sb, "proxyHost", 2 );
3470 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
3471 append( sb, "", 0 );
3472 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 );
3473 append( sb, "Expression: ${proxyHost}", 3 );
3474 append( sb, "", 0 );
3475
3476 append( sb, "proxyPort", 2 );
3477 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
3478 append( sb, "", 0 );
3479 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 );
3480 append( sb, "Expression: ${proxyPort}", 3 );
3481 append( sb, "", 0 );
3482
3483 append( sb, "quiet (Default: false)", 2 );
3484 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 );
3485 append( sb, "Expression: ${quiet}", 3 );
3486 append( sb, "", 0 );
3487
3488 append( sb, "remoteRepositories", 2 );
3489 append( sb, "The remote repositories where artifacts are located.", 3 );
3490 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
3491 append( sb, "", 0 );
3492
3493 append( sb, "resourcesArtifacts", 2 );
3494 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 );
3495 append( sb, "Expression: ${resourcesArtifacts}", 3 );
3496 append( sb, "", 0 );
3497
3498 append( sb, "serialwarn (Default: false)", 2 );
3499 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
3500 append( sb, "Expression: ${serialwarn}", 3 );
3501 append( sb, "", 0 );
3502
3503 append( sb, "show (Default: protected)", 2 );
3504 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 );
3505 append( sb, "Expression: ${show}", 3 );
3506 append( sb, "", 0 );
3507
3508 append( sb, "skip (Default: false)", 2 );
3509 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
3510 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
3511 append( sb, "", 0 );
3512
3513 append( sb, "source", 2 );
3514 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
3515 append( sb, "Expression: ${source}", 3 );
3516 append( sb, "", 0 );
3517
3518 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
3519 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
3520 append( sb, "", 0 );
3521
3522 append( sb, "sourcepath", 2 );
3523 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
3524 append( sb, "Expression: ${sourcepath}", 3 );
3525 append( sb, "", 0 );
3526
3527 append( sb, "sourcetab", 2 );
3528 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 );
3529 append( sb, "Expression: ${sourcetab}", 3 );
3530 append( sb, "", 0 );
3531
3532 append( sb, "splitindex (Default: false)", 2 );
3533 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 );
3534 append( sb, "Expression: ${splitindex}", 3 );
3535 append( sb, "", 0 );
3536
3537 append( sb, "stylesheet (Default: java)", 2 );
3538 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
3539 append( sb, "Expression: ${stylesheet}", 3 );
3540 append( sb, "", 0 );
3541
3542 append( sb, "stylesheetfile", 2 );
3543 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
3544 append( sb, "Expression: ${stylesheetfile}", 3 );
3545 append( sb, "", 0 );
3546
3547 append( sb, "subpackages", 2 );
3548 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 );
3549 append( sb, "Expression: ${subpackages}", 3 );
3550 append( sb, "", 0 );
3551
3552 append( sb, "taglet", 2 );
3553 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 );
3554 append( sb, "Expression: ${taglet}", 3 );
3555 append( sb, "", 0 );
3556
3557 append( sb, "tagletArtifact", 2 );
3558 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 );
3559 append( sb, "Expression: ${tagletArtifact}", 3 );
3560 append( sb, "", 0 );
3561
3562 append( sb, "tagletArtifacts", 2 );
3563 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 );
3564 append( sb, "Expression: ${tagletArtifacts}", 3 );
3565 append( sb, "", 0 );
3566
3567 append( sb, "tagletpath", 2 );
3568 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
3569 append( sb, "Expression: ${tagletpath}", 3 );
3570 append( sb, "", 0 );
3571
3572 append( sb, "taglets", 2 );
3573 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 );
3574 append( sb, "Expression: ${taglets}", 3 );
3575 append( sb, "", 0 );
3576
3577 append( sb, "tags", 2 );
3578 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
3579 append( sb, "Expression: ${tags}", 3 );
3580 append( sb, "", 0 );
3581
3582 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
3583 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3584 append( sb, "Expression: ${testDoctitle}", 3 );
3585 append( sb, "", 0 );
3586
3587 append( sb, "testJavadocDirectory", 2 );
3588 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
3589 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
3590 append( sb, "", 0 );
3591
3592 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
3593 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 );
3594 append( sb, "Expression: ${testOverview}", 3 );
3595 append( sb, "", 0 );
3596
3597 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
3598 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3599 append( sb, "Expression: ${testWindowtitle}", 3 );
3600 append( sb, "", 0 );
3601
3602 append( sb, "top", 2 );
3603 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
3604 append( sb, "Expression: ${top}", 3 );
3605 append( sb, "", 0 );
3606
3607 append( sb, "use (Default: true)", 2 );
3608 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
3609 append( sb, "Expression: ${use}", 3 );
3610 append( sb, "", 0 );
3611
3612 append( sb, "useDefaultManifestFile (Default: false)", 2 );
3613 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
3614 append( sb, "", 0 );
3615
3616 append( sb, "useStandardDocletOptions (Default: true)", 2 );
3617 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 );
3618 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
3619 append( sb, "", 0 );
3620
3621 append( sb, "validateLinks (Default: false)", 2 );
3622 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
3623 append( sb, "Expression: ${validateLinks}", 3 );
3624 append( sb, "", 0 );
3625
3626 append( sb, "verbose (Default: false)", 2 );
3627 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
3628 append( sb, "Expression: ${verbose}", 3 );
3629 append( sb, "", 0 );
3630
3631 append( sb, "version (Default: true)", 2 );
3632 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
3633 append( sb, "Expression: ${version}", 3 );
3634 append( sb, "", 0 );
3635
3636 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
3637 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3638 append( sb, "Expression: ${windowtitle}", 3 );
3639 append( sb, "", 0 );
3640 }
3641 }
3642
3643 if ( goal == null || goal.length() <= 0 || "test-fix".equals( goal ) )
3644 {
3645 append( sb, "javadoc:test-fix", 0 );
3646 append( sb, "Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.", 1 );
3647 append( sb, "", 0 );
3648 if ( detail )
3649 {
3650 append( sb, "Available parameters:", 1 );
3651 append( sb, "", 0 );
3652
3653 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
3654 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
3655 append( sb, "Expression: ${comparisonVersion}", 3 );
3656 append( sb, "", 0 );
3657
3658 append( sb, "defaultAuthor", 2 );
3659 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
3660 append( sb, "Expression: ${defaultAuthor}", 3 );
3661 append( sb, "", 0 );
3662
3663 append( sb, "defaultSince (Default: ${project.version})", 2 );
3664 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
3665 append( sb, "Expression: ${defaultSince}", 3 );
3666 append( sb, "", 0 );
3667
3668 append( sb, "defaultVersion", 2 );
3669 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
3670 append( sb, "Expression: ${defaultVersion}", 3 );
3671 append( sb, "", 0 );
3672
3673 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3674 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
3675 append( sb, "Expression: ${encoding}", 3 );
3676 append( sb, "", 0 );
3677
3678 append( sb, "excludes", 2 );
3679 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
3680 append( sb, "Expression: ${excludes}", 3 );
3681 append( sb, "", 0 );
3682
3683 append( sb, "fixClassComment (Default: true)", 2 );
3684 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
3685 append( sb, "Expression: ${fixClassComment}", 3 );
3686 append( sb, "", 0 );
3687
3688 append( sb, "fixFieldComment (Default: true)", 2 );
3689 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
3690 append( sb, "Expression: ${fixFieldComment}", 3 );
3691 append( sb, "", 0 );
3692
3693 append( sb, "fixMethodComment (Default: true)", 2 );
3694 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
3695 append( sb, "Expression: ${fixMethodComment}", 3 );
3696 append( sb, "", 0 );
3697
3698 append( sb, "fixTags (Default: all)", 2 );
3699 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n-\tlink (fix only @link tag)\n", 3 );
3700 append( sb, "Expression: ${fixTags}", 3 );
3701 append( sb, "", 0 );
3702
3703 append( sb, "force", 2 );
3704 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
3705 append( sb, "Expression: ${force}", 3 );
3706 append( sb, "", 0 );
3707
3708 append( sb, "ignoreClirr (Default: false)", 2 );
3709 append( sb, "Flag to ignore or not Clirr.", 3 );
3710 append( sb, "Expression: ${ignoreClirr}", 3 );
3711 append( sb, "", 0 );
3712
3713 append( sb, "includes (Default: **/*.java)", 2 );
3714 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
3715 append( sb, "Expression: ${includes}", 3 );
3716 append( sb, "", 0 );
3717
3718 append( sb, "level (Default: protected)", 2 );
3719 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 );
3720 append( sb, "Expression: ${level}", 3 );
3721 append( sb, "", 0 );
3722
3723 append( sb, "localRepository", 2 );
3724 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
3725 append( sb, "Expression: ${localRepository}", 3 );
3726 append( sb, "", 0 );
3727
3728 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
3729 append( sb, "Output directory where Java classes will be rewritten.", 3 );
3730 append( sb, "Expression: ${outputDirectory}", 3 );
3731 append( sb, "", 0 );
3732 }
3733 }
3734
3735 if ( goal == null || goal.length() <= 0 || "test-jar".equals( goal ) )
3736 {
3737 append( sb, "javadoc:test-jar", 0 );
3738 append( sb, "Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
3739 append( sb, "", 0 );
3740 if ( detail )
3741 {
3742 append( sb, "Available parameters:", 1 );
3743 append( sb, "", 0 );
3744
3745 append( sb, "additionalJOption", 2 );
3746 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
3747 append( sb, "Expression: ${additionalJOption}", 3 );
3748 append( sb, "", 0 );
3749
3750 append( sb, "additionalparam", 2 );
3751 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 );
3752 append( sb, "Expression: ${additionalparam}", 3 );
3753 append( sb, "", 0 );
3754
3755 append( sb, "additionnalDependencies", 2 );
3756 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
3757 append( sb, "", 0 );
3758
3759 append( sb, "aggregate (Default: false)", 2 );
3760 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
3761 append( sb, "", 0 );
3762 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
3763 append( sb, "Expression: ${aggregate}", 3 );
3764 append( sb, "", 0 );
3765
3766 append( sb, "archive", 2 );
3767 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
3768 append( sb, "", 0 );
3769
3770 append( sb, "attach (Default: true)", 2 );
3771 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
3772 append( sb, "Expression: ${attach}", 3 );
3773 append( sb, "", 0 );
3774
3775 append( sb, "author (Default: true)", 2 );
3776 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
3777 append( sb, "Expression: ${author}", 3 );
3778 append( sb, "", 0 );
3779
3780 append( sb, "bootclasspath", 2 );
3781 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
3782 append( sb, "Expression: ${bootclasspath}", 3 );
3783 append( sb, "", 0 );
3784
3785 append( sb, "bootclasspathArtifacts", 2 );
3786 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 );
3787 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
3788 append( sb, "", 0 );
3789
3790 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
3791 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 );
3792 append( sb, "Expression: ${bottom}", 3 );
3793 append( sb, "", 0 );
3794
3795 append( sb, "breakiterator (Default: false)", 2 );
3796 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
3797 append( sb, "Expression: ${breakiterator}", 3 );
3798 append( sb, "", 0 );
3799
3800 append( sb, "charset", 2 );
3801 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 );
3802 append( sb, "Expression: ${charset}", 3 );
3803 append( sb, "", 0 );
3804
3805 append( sb, "debug (Default: false)", 2 );
3806 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
3807 append( sb, "Expression: ${debug}", 3 );
3808 append( sb, "", 0 );
3809
3810 append( sb, "dependencySourceExcludes", 2 );
3811 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
3812 append( sb, "", 0 );
3813
3814 append( sb, "dependencySourceIncludes", 2 );
3815 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
3816 append( sb, "", 0 );
3817
3818 append( sb, "destDir", 2 );
3819 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
3820 append( sb, "Expression: ${destDir}", 3 );
3821 append( sb, "", 0 );
3822
3823 append( sb, "detectJavaApiLink (Default: true)", 2 );
3824 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
3825 append( sb, "Expression: ${detectJavaApiLink}", 3 );
3826 append( sb, "", 0 );
3827
3828 append( sb, "detectLinks (Default: false)", 2 );
3829 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
3830 append( sb, "Expression: ${detectLinks}", 3 );
3831 append( sb, "", 0 );
3832
3833 append( sb, "detectOfflineLinks (Default: true)", 2 );
3834 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
3835 append( sb, "Expression: ${detectOfflineLinks}", 3 );
3836 append( sb, "", 0 );
3837
3838 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
3839 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
3840 append( sb, "Expression: ${docencoding}", 3 );
3841 append( sb, "", 0 );
3842
3843 append( sb, "docfilessubdirs (Default: false)", 2 );
3844 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
3845 append( sb, "Expression: ${docfilessubdirs}", 3 );
3846 append( sb, "", 0 );
3847
3848 append( sb, "doclet", 2 );
3849 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
3850 append( sb, "Expression: ${doclet}", 3 );
3851 append( sb, "", 0 );
3852
3853 append( sb, "docletArtifact", 2 );
3854 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 );
3855 append( sb, "Expression: ${docletArtifact}", 3 );
3856 append( sb, "", 0 );
3857
3858 append( sb, "docletArtifacts", 2 );
3859 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 );
3860 append( sb, "Expression: ${docletArtifacts}", 3 );
3861 append( sb, "", 0 );
3862
3863 append( sb, "docletPath", 2 );
3864 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
3865 append( sb, "Expression: ${docletPath}", 3 );
3866 append( sb, "", 0 );
3867
3868 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
3869 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3870 append( sb, "Expression: ${doctitle}", 3 );
3871 append( sb, "", 0 );
3872
3873 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3874 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 );
3875 append( sb, "Expression: ${encoding}", 3 );
3876 append( sb, "", 0 );
3877
3878 append( sb, "excludedocfilessubdir", 2 );
3879 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 );
3880 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
3881 append( sb, "", 0 );
3882
3883 append( sb, "excludePackageNames", 2 );
3884 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
3885 append( sb, "Expression: ${excludePackageNames}", 3 );
3886 append( sb, "", 0 );
3887
3888 append( sb, "extdirs", 2 );
3889 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
3890 append( sb, "Expression: ${extdirs}", 3 );
3891 append( sb, "", 0 );
3892
3893 append( sb, "failOnError (Default: true)", 2 );
3894 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
3895 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
3896 append( sb, "", 0 );
3897
3898 append( sb, "finalName", 2 );
3899 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 );
3900 append( sb, "Expression: ${project.build.finalName}", 3 );
3901 append( sb, "", 0 );
3902
3903 append( sb, "footer", 2 );
3904 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
3905 append( sb, "Expression: ${footer}", 3 );
3906 append( sb, "", 0 );
3907
3908 append( sb, "groups", 2 );
3909 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
3910 append( sb, "Expression: ${groups}", 3 );
3911 append( sb, "", 0 );
3912
3913 append( sb, "header", 2 );
3914 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
3915 append( sb, "Expression: ${header}", 3 );
3916 append( sb, "", 0 );
3917
3918 append( sb, "helpfile", 2 );
3919 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
3920 append( sb, "Expression: ${helpfile}", 3 );
3921 append( sb, "", 0 );
3922
3923 append( sb, "includeDependencySources (Default: false)", 2 );
3924 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
3925 append( sb, "", 0 );
3926
3927 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
3928 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
3929 append( sb, "", 0 );
3930
3931 append( sb, "jarOutputDirectory", 2 );
3932 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
3933 append( sb, "Expression: ${project.build.directory}", 3 );
3934 append( sb, "", 0 );
3935
3936 append( sb, "javaApiLinks", 2 );
3937 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
3938 append( sb, "Expression: ${javaApiLinks}", 3 );
3939 append( sb, "", 0 );
3940
3941 append( sb, "javadocDirectory", 2 );
3942 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 );
3943 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
3944 append( sb, "", 0 );
3945
3946 append( sb, "javadocExecutable", 2 );
3947 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 );
3948 append( sb, "Expression: ${javadocExecutable}", 3 );
3949 append( sb, "", 0 );
3950
3951 append( sb, "javadocVersion", 2 );
3952 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
3953 append( sb, "Expression: ${javadocVersion}", 3 );
3954 append( sb, "", 0 );
3955
3956 append( sb, "keywords (Default: false)", 2 );
3957 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 );
3958 append( sb, "Expression: ${keywords}", 3 );
3959 append( sb, "", 0 );
3960
3961 append( sb, "links", 2 );
3962 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
3963 append( sb, "Expression: ${links}", 3 );
3964 append( sb, "", 0 );
3965
3966 append( sb, "linksource (Default: false)", 2 );
3967 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 );
3968 append( sb, "Expression: ${linksource}", 3 );
3969 append( sb, "", 0 );
3970
3971 append( sb, "locale", 2 );
3972 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
3973 append( sb, "Expression: ${locale}", 3 );
3974 append( sb, "", 0 );
3975
3976 append( sb, "localRepository", 2 );
3977 append( sb, "The local repository where the artifacts are located.", 3 );
3978 append( sb, "Expression: ${localRepository}", 3 );
3979 append( sb, "", 0 );
3980
3981 append( sb, "maxmemory", 2 );
3982 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 );
3983 append( sb, "Expression: ${maxmemory}", 3 );
3984 append( sb, "", 0 );
3985
3986 append( sb, "minmemory", 2 );
3987 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 );
3988 append( sb, "Expression: ${minmemory}", 3 );
3989 append( sb, "", 0 );
3990
3991 append( sb, "nocomment (Default: false)", 2 );
3992 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 );
3993 append( sb, "Expression: ${nocomment}", 3 );
3994 append( sb, "", 0 );
3995
3996 append( sb, "nodeprecated (Default: false)", 2 );
3997 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
3998 append( sb, "Expression: ${nodeprecated}", 3 );
3999 append( sb, "", 0 );
4000
4001 append( sb, "nodeprecatedlist (Default: false)", 2 );
4002 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 );
4003 append( sb, "Expression: ${nodeprecatedlist}", 3 );
4004 append( sb, "", 0 );
4005
4006 append( sb, "nohelp (Default: false)", 2 );
4007 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 );
4008 append( sb, "Expression: ${nohelp}", 3 );
4009 append( sb, "", 0 );
4010
4011 append( sb, "noindex (Default: false)", 2 );
4012 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
4013 append( sb, "Expression: ${noindex}", 3 );
4014 append( sb, "", 0 );
4015
4016 append( sb, "nonavbar (Default: false)", 2 );
4017 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
4018 append( sb, "Expression: ${nonavbar}", 3 );
4019 append( sb, "", 0 );
4020
4021 append( sb, "nooverview (Default: false)", 2 );
4022 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
4023 append( sb, "Expression: ${nooverview}", 3 );
4024 append( sb, "", 0 );
4025
4026 append( sb, "noqualifier", 2 );
4027 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
4028 append( sb, "Expression: ${noqualifier}", 3 );
4029 append( sb, "", 0 );
4030
4031 append( sb, "nosince (Default: false)", 2 );
4032 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
4033 append( sb, "Expression: ${nosince}", 3 );
4034 append( sb, "", 0 );
4035
4036 append( sb, "notimestamp (Default: false)", 2 );
4037 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 );
4038 append( sb, "Expression: ${notimestamp}", 3 );
4039 append( sb, "", 0 );
4040
4041 append( sb, "notree (Default: false)", 2 );
4042 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
4043 append( sb, "Expression: ${notree}", 3 );
4044 append( sb, "", 0 );
4045
4046 append( sb, "offlineLinks", 2 );
4047 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
4048 append( sb, "Expression: ${offlineLinks}", 3 );
4049 append( sb, "", 0 );
4050
4051 append( sb, "old (Default: false)", 2 );
4052 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
4053 append( sb, "Expression: ${old}", 3 );
4054 append( sb, "", 0 );
4055
4056 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
4057 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
4058 append( sb, "Required: Yes", 3 );
4059 append( sb, "", 0 );
4060
4061 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
4062 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 );
4063 append( sb, "Expression: ${overview}", 3 );
4064 append( sb, "", 0 );
4065
4066 append( sb, "packagesheader", 2 );
4067 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
4068 append( sb, "Expression: ${packagesheader}", 3 );
4069 append( sb, "", 0 );
4070
4071 append( sb, "proxyHost", 2 );
4072 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
4073 append( sb, "", 0 );
4074 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 );
4075 append( sb, "Expression: ${proxyHost}", 3 );
4076 append( sb, "", 0 );
4077
4078 append( sb, "proxyPort", 2 );
4079 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
4080 append( sb, "", 0 );
4081 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 );
4082 append( sb, "Expression: ${proxyPort}", 3 );
4083 append( sb, "", 0 );
4084
4085 append( sb, "quiet (Default: false)", 2 );
4086 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 );
4087 append( sb, "Expression: ${quiet}", 3 );
4088 append( sb, "", 0 );
4089
4090 append( sb, "remoteRepositories", 2 );
4091 append( sb, "The remote repositories where artifacts are located.", 3 );
4092 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
4093 append( sb, "", 0 );
4094
4095 append( sb, "resourcesArtifacts", 2 );
4096 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 );
4097 append( sb, "Expression: ${resourcesArtifacts}", 3 );
4098 append( sb, "", 0 );
4099
4100 append( sb, "serialwarn (Default: false)", 2 );
4101 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
4102 append( sb, "Expression: ${serialwarn}", 3 );
4103 append( sb, "", 0 );
4104
4105 append( sb, "show (Default: protected)", 2 );
4106 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 );
4107 append( sb, "Expression: ${show}", 3 );
4108 append( sb, "", 0 );
4109
4110 append( sb, "skip (Default: false)", 2 );
4111 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
4112 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
4113 append( sb, "", 0 );
4114
4115 append( sb, "source", 2 );
4116 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
4117 append( sb, "Expression: ${source}", 3 );
4118 append( sb, "", 0 );
4119
4120 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
4121 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
4122 append( sb, "", 0 );
4123
4124 append( sb, "sourcepath", 2 );
4125 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
4126 append( sb, "Expression: ${sourcepath}", 3 );
4127 append( sb, "", 0 );
4128
4129 append( sb, "sourcetab", 2 );
4130 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 );
4131 append( sb, "Expression: ${sourcetab}", 3 );
4132 append( sb, "", 0 );
4133
4134 append( sb, "splitindex (Default: false)", 2 );
4135 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
4136 append( sb, "Expression: ${splitindex}", 3 );
4137 append( sb, "", 0 );
4138
4139 append( sb, "stylesheet (Default: java)", 2 );
4140 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
4141 append( sb, "Expression: ${stylesheet}", 3 );
4142 append( sb, "", 0 );
4143
4144 append( sb, "stylesheetfile", 2 );
4145 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
4146 append( sb, "Expression: ${stylesheetfile}", 3 );
4147 append( sb, "", 0 );
4148
4149 append( sb, "subpackages", 2 );
4150 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 );
4151 append( sb, "Expression: ${subpackages}", 3 );
4152 append( sb, "", 0 );
4153
4154 append( sb, "taglet", 2 );
4155 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 );
4156 append( sb, "Expression: ${taglet}", 3 );
4157 append( sb, "", 0 );
4158
4159 append( sb, "tagletArtifact", 2 );
4160 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 );
4161 append( sb, "Expression: ${tagletArtifact}", 3 );
4162 append( sb, "", 0 );
4163
4164 append( sb, "tagletArtifacts", 2 );
4165 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 );
4166 append( sb, "Expression: ${tagletArtifacts}", 3 );
4167 append( sb, "", 0 );
4168
4169 append( sb, "tagletpath", 2 );
4170 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
4171 append( sb, "Expression: ${tagletpath}", 3 );
4172 append( sb, "", 0 );
4173
4174 append( sb, "taglets", 2 );
4175 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 );
4176 append( sb, "Expression: ${taglets}", 3 );
4177 append( sb, "", 0 );
4178
4179 append( sb, "tags", 2 );
4180 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
4181 append( sb, "Expression: ${tags}", 3 );
4182 append( sb, "", 0 );
4183
4184 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
4185 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4186 append( sb, "Expression: ${testDoctitle}", 3 );
4187 append( sb, "", 0 );
4188
4189 append( sb, "testJavadocDirectory", 2 );
4190 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
4191 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
4192 append( sb, "", 0 );
4193
4194 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
4195 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 );
4196 append( sb, "Expression: ${testOverview}", 3 );
4197 append( sb, "", 0 );
4198
4199 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
4200 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4201 append( sb, "Expression: ${testWindowtitle}", 3 );
4202 append( sb, "", 0 );
4203
4204 append( sb, "top", 2 );
4205 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
4206 append( sb, "Expression: ${top}", 3 );
4207 append( sb, "", 0 );
4208
4209 append( sb, "use (Default: true)", 2 );
4210 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
4211 append( sb, "Expression: ${use}", 3 );
4212 append( sb, "", 0 );
4213
4214 append( sb, "useDefaultManifestFile (Default: false)", 2 );
4215 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
4216 append( sb, "", 0 );
4217
4218 append( sb, "useStandardDocletOptions (Default: true)", 2 );
4219 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 );
4220 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
4221 append( sb, "", 0 );
4222
4223 append( sb, "validateLinks (Default: false)", 2 );
4224 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
4225 append( sb, "Expression: ${validateLinks}", 3 );
4226 append( sb, "", 0 );
4227
4228 append( sb, "verbose (Default: false)", 2 );
4229 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
4230 append( sb, "Expression: ${verbose}", 3 );
4231 append( sb, "", 0 );
4232
4233 append( sb, "version (Default: true)", 2 );
4234 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
4235 append( sb, "Expression: ${version}", 3 );
4236 append( sb, "", 0 );
4237
4238 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
4239 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4240 append( sb, "Expression: ${windowtitle}", 3 );
4241 append( sb, "", 0 );
4242 }
4243 }
4244
4245 if ( goal == null || goal.length() <= 0 || "test-javadoc".equals( goal ) )
4246 {
4247 append( sb, "javadoc:test-javadoc", 0 );
4248 append( sb, "Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.", 1 );
4249 append( sb, "", 0 );
4250 if ( detail )
4251 {
4252 append( sb, "Available parameters:", 1 );
4253 append( sb, "", 0 );
4254
4255 append( sb, "additionalJOption", 2 );
4256 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
4257 append( sb, "Expression: ${additionalJOption}", 3 );
4258 append( sb, "", 0 );
4259
4260 append( sb, "additionalparam", 2 );
4261 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 );
4262 append( sb, "Expression: ${additionalparam}", 3 );
4263 append( sb, "", 0 );
4264
4265 append( sb, "additionnalDependencies", 2 );
4266 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
4267 append( sb, "", 0 );
4268
4269 append( sb, "aggregate (Default: false)", 2 );
4270 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
4271 append( sb, "", 0 );
4272 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
4273 append( sb, "Expression: ${aggregate}", 3 );
4274 append( sb, "", 0 );
4275
4276 append( sb, "author (Default: true)", 2 );
4277 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
4278 append( sb, "Expression: ${author}", 3 );
4279 append( sb, "", 0 );
4280
4281 append( sb, "bootclasspath", 2 );
4282 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
4283 append( sb, "Expression: ${bootclasspath}", 3 );
4284 append( sb, "", 0 );
4285
4286 append( sb, "bootclasspathArtifacts", 2 );
4287 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 );
4288 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
4289 append( sb, "", 0 );
4290
4291 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
4292 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 );
4293 append( sb, "Expression: ${bottom}", 3 );
4294 append( sb, "", 0 );
4295
4296 append( sb, "breakiterator (Default: false)", 2 );
4297 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
4298 append( sb, "Expression: ${breakiterator}", 3 );
4299 append( sb, "", 0 );
4300
4301 append( sb, "charset", 2 );
4302 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 );
4303 append( sb, "Expression: ${charset}", 3 );
4304 append( sb, "", 0 );
4305
4306 append( sb, "debug (Default: false)", 2 );
4307 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
4308 append( sb, "Expression: ${debug}", 3 );
4309 append( sb, "", 0 );
4310
4311 append( sb, "dependencySourceExcludes", 2 );
4312 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
4313 append( sb, "", 0 );
4314
4315 append( sb, "dependencySourceIncludes", 2 );
4316 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
4317 append( sb, "", 0 );
4318
4319 append( sb, "description", 2 );
4320 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4321 append( sb, "Expression: ${description}", 3 );
4322 append( sb, "", 0 );
4323
4324 append( sb, "destDir (Default: testapidocs)", 2 );
4325 append( sb, "The name of the destination directory.\n", 3 );
4326 append( sb, "Expression: ${destDir}", 3 );
4327 append( sb, "", 0 );
4328
4329 append( sb, "detectJavaApiLink (Default: true)", 2 );
4330 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
4331 append( sb, "Expression: ${detectJavaApiLink}", 3 );
4332 append( sb, "", 0 );
4333
4334 append( sb, "detectLinks (Default: false)", 2 );
4335 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
4336 append( sb, "Expression: ${detectLinks}", 3 );
4337 append( sb, "", 0 );
4338
4339 append( sb, "detectOfflineLinks (Default: true)", 2 );
4340 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
4341 append( sb, "Expression: ${detectOfflineLinks}", 3 );
4342 append( sb, "", 0 );
4343
4344 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
4345 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
4346 append( sb, "Expression: ${docencoding}", 3 );
4347 append( sb, "", 0 );
4348
4349 append( sb, "docfilessubdirs (Default: false)", 2 );
4350 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
4351 append( sb, "Expression: ${docfilessubdirs}", 3 );
4352 append( sb, "", 0 );
4353
4354 append( sb, "doclet", 2 );
4355 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
4356 append( sb, "Expression: ${doclet}", 3 );
4357 append( sb, "", 0 );
4358
4359 append( sb, "docletArtifact", 2 );
4360 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 );
4361 append( sb, "Expression: ${docletArtifact}", 3 );
4362 append( sb, "", 0 );
4363
4364 append( sb, "docletArtifacts", 2 );
4365 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 );
4366 append( sb, "Expression: ${docletArtifacts}", 3 );
4367 append( sb, "", 0 );
4368
4369 append( sb, "docletPath", 2 );
4370 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
4371 append( sb, "Expression: ${docletPath}", 3 );
4372 append( sb, "", 0 );
4373
4374 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
4375 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4376 append( sb, "Expression: ${doctitle}", 3 );
4377 append( sb, "", 0 );
4378
4379 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
4380 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 );
4381 append( sb, "Expression: ${encoding}", 3 );
4382 append( sb, "", 0 );
4383
4384 append( sb, "excludedocfilessubdir", 2 );
4385 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 );
4386 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
4387 append( sb, "", 0 );
4388
4389 append( sb, "excludePackageNames", 2 );
4390 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
4391 append( sb, "Expression: ${excludePackageNames}", 3 );
4392 append( sb, "", 0 );
4393
4394 append( sb, "extdirs", 2 );
4395 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
4396 append( sb, "Expression: ${extdirs}", 3 );
4397 append( sb, "", 0 );
4398
4399 append( sb, "failOnError (Default: true)", 2 );
4400 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
4401 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
4402 append( sb, "", 0 );
4403
4404 append( sb, "footer", 2 );
4405 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
4406 append( sb, "Expression: ${footer}", 3 );
4407 append( sb, "", 0 );
4408
4409 append( sb, "groups", 2 );
4410 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
4411 append( sb, "Expression: ${groups}", 3 );
4412 append( sb, "", 0 );
4413
4414 append( sb, "header", 2 );
4415 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
4416 append( sb, "Expression: ${header}", 3 );
4417 append( sb, "", 0 );
4418
4419 append( sb, "helpfile", 2 );
4420 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
4421 append( sb, "Expression: ${helpfile}", 3 );
4422 append( sb, "", 0 );
4423
4424 append( sb, "includeDependencySources (Default: false)", 2 );
4425 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
4426 append( sb, "", 0 );
4427
4428 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
4429 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
4430 append( sb, "", 0 );
4431
4432 append( sb, "javaApiLinks", 2 );
4433 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
4434 append( sb, "Expression: ${javaApiLinks}", 3 );
4435 append( sb, "", 0 );
4436
4437 append( sb, "javadocDirectory", 2 );
4438 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 );
4439 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
4440 append( sb, "", 0 );
4441
4442 append( sb, "javadocExecutable", 2 );
4443 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 );
4444 append( sb, "Expression: ${javadocExecutable}", 3 );
4445 append( sb, "", 0 );
4446
4447 append( sb, "javadocVersion", 2 );
4448 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
4449 append( sb, "Expression: ${javadocVersion}", 3 );
4450 append( sb, "", 0 );
4451
4452 append( sb, "keywords (Default: false)", 2 );
4453 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 );
4454 append( sb, "Expression: ${keywords}", 3 );
4455 append( sb, "", 0 );
4456
4457 append( sb, "links", 2 );
4458 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
4459 append( sb, "Expression: ${links}", 3 );
4460 append( sb, "", 0 );
4461
4462 append( sb, "linksource (Default: false)", 2 );
4463 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 );
4464 append( sb, "Expression: ${linksource}", 3 );
4465 append( sb, "", 0 );
4466
4467 append( sb, "locale", 2 );
4468 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
4469 append( sb, "Expression: ${locale}", 3 );
4470 append( sb, "", 0 );
4471
4472 append( sb, "localRepository", 2 );
4473 append( sb, "The local repository where the artifacts are located.", 3 );
4474 append( sb, "Expression: ${localRepository}", 3 );
4475 append( sb, "", 0 );
4476
4477 append( sb, "maxmemory", 2 );
4478 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 );
4479 append( sb, "Expression: ${maxmemory}", 3 );
4480 append( sb, "", 0 );
4481
4482 append( sb, "minmemory", 2 );
4483 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 );
4484 append( sb, "Expression: ${minmemory}", 3 );
4485 append( sb, "", 0 );
4486
4487 append( sb, "name", 2 );
4488 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4489 append( sb, "Expression: ${name}", 3 );
4490 append( sb, "", 0 );
4491
4492 append( sb, "nocomment (Default: false)", 2 );
4493 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 );
4494 append( sb, "Expression: ${nocomment}", 3 );
4495 append( sb, "", 0 );
4496
4497 append( sb, "nodeprecated (Default: false)", 2 );
4498 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
4499 append( sb, "Expression: ${nodeprecated}", 3 );
4500 append( sb, "", 0 );
4501
4502 append( sb, "nodeprecatedlist (Default: false)", 2 );
4503 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 );
4504 append( sb, "Expression: ${nodeprecatedlist}", 3 );
4505 append( sb, "", 0 );
4506
4507 append( sb, "nohelp (Default: false)", 2 );
4508 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 );
4509 append( sb, "Expression: ${nohelp}", 3 );
4510 append( sb, "", 0 );
4511
4512 append( sb, "noindex (Default: false)", 2 );
4513 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
4514 append( sb, "Expression: ${noindex}", 3 );
4515 append( sb, "", 0 );
4516
4517 append( sb, "nonavbar (Default: false)", 2 );
4518 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
4519 append( sb, "Expression: ${nonavbar}", 3 );
4520 append( sb, "", 0 );
4521
4522 append( sb, "nooverview (Default: false)", 2 );
4523 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
4524 append( sb, "Expression: ${nooverview}", 3 );
4525 append( sb, "", 0 );
4526
4527 append( sb, "noqualifier", 2 );
4528 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
4529 append( sb, "Expression: ${noqualifier}", 3 );
4530 append( sb, "", 0 );
4531
4532 append( sb, "nosince (Default: false)", 2 );
4533 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
4534 append( sb, "Expression: ${nosince}", 3 );
4535 append( sb, "", 0 );
4536
4537 append( sb, "notimestamp (Default: false)", 2 );
4538 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 );
4539 append( sb, "Expression: ${notimestamp}", 3 );
4540 append( sb, "", 0 );
4541
4542 append( sb, "notree (Default: false)", 2 );
4543 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
4544 append( sb, "Expression: ${notree}", 3 );
4545 append( sb, "", 0 );
4546
4547 append( sb, "offlineLinks", 2 );
4548 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
4549 append( sb, "Expression: ${offlineLinks}", 3 );
4550 append( sb, "", 0 );
4551
4552 append( sb, "old (Default: false)", 2 );
4553 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
4554 append( sb, "Expression: ${old}", 3 );
4555 append( sb, "", 0 );
4556
4557 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
4558 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
4559 append( sb, "Required: Yes", 3 );
4560 append( sb, "Expression: ${destDir}", 3 );
4561 append( sb, "", 0 );
4562
4563 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
4564 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 );
4565 append( sb, "Expression: ${overview}", 3 );
4566 append( sb, "", 0 );
4567
4568 append( sb, "packagesheader", 2 );
4569 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
4570 append( sb, "Expression: ${packagesheader}", 3 );
4571 append( sb, "", 0 );
4572
4573 append( sb, "proxyHost", 2 );
4574 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
4575 append( sb, "", 0 );
4576 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 );
4577 append( sb, "Expression: ${proxyHost}", 3 );
4578 append( sb, "", 0 );
4579
4580 append( sb, "proxyPort", 2 );
4581 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
4582 append( sb, "", 0 );
4583 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 );
4584 append( sb, "Expression: ${proxyPort}", 3 );
4585 append( sb, "", 0 );
4586
4587 append( sb, "quiet (Default: false)", 2 );
4588 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 );
4589 append( sb, "Expression: ${quiet}", 3 );
4590 append( sb, "", 0 );
4591
4592 append( sb, "remoteRepositories", 2 );
4593 append( sb, "The remote repositories where artifacts are located.", 3 );
4594 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
4595 append( sb, "", 0 );
4596
4597 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
4598 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
4599 append( sb, "Required: Yes", 3 );
4600 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
4601 append( sb, "", 0 );
4602
4603 append( sb, "resourcesArtifacts", 2 );
4604 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 );
4605 append( sb, "Expression: ${resourcesArtifacts}", 3 );
4606 append( sb, "", 0 );
4607
4608 append( sb, "serialwarn (Default: false)", 2 );
4609 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
4610 append( sb, "Expression: ${serialwarn}", 3 );
4611 append( sb, "", 0 );
4612
4613 append( sb, "show (Default: protected)", 2 );
4614 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 );
4615 append( sb, "Expression: ${show}", 3 );
4616 append( sb, "", 0 );
4617
4618 append( sb, "skip (Default: false)", 2 );
4619 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
4620 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
4621 append( sb, "", 0 );
4622
4623 append( sb, "source", 2 );
4624 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
4625 append( sb, "Expression: ${source}", 3 );
4626 append( sb, "", 0 );
4627
4628 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
4629 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
4630 append( sb, "", 0 );
4631
4632 append( sb, "sourcepath", 2 );
4633 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
4634 append( sb, "Expression: ${sourcepath}", 3 );
4635 append( sb, "", 0 );
4636
4637 append( sb, "sourcetab", 2 );
4638 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 );
4639 append( sb, "Expression: ${sourcetab}", 3 );
4640 append( sb, "", 0 );
4641
4642 append( sb, "splitindex (Default: false)", 2 );
4643 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 );
4644 append( sb, "Expression: ${splitindex}", 3 );
4645 append( sb, "", 0 );
4646
4647 append( sb, "stylesheet (Default: java)", 2 );
4648 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
4649 append( sb, "Expression: ${stylesheet}", 3 );
4650 append( sb, "", 0 );
4651
4652 append( sb, "stylesheetfile", 2 );
4653 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
4654 append( sb, "Expression: ${stylesheetfile}", 3 );
4655 append( sb, "", 0 );
4656
4657 append( sb, "subpackages", 2 );
4658 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 );
4659 append( sb, "Expression: ${subpackages}", 3 );
4660 append( sb, "", 0 );
4661
4662 append( sb, "taglet", 2 );
4663 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 );
4664 append( sb, "Expression: ${taglet}", 3 );
4665 append( sb, "", 0 );
4666
4667 append( sb, "tagletArtifact", 2 );
4668 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 );
4669 append( sb, "Expression: ${tagletArtifact}", 3 );
4670 append( sb, "", 0 );
4671
4672 append( sb, "tagletArtifacts", 2 );
4673 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 );
4674 append( sb, "Expression: ${tagletArtifacts}", 3 );
4675 append( sb, "", 0 );
4676
4677 append( sb, "tagletpath", 2 );
4678 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
4679 append( sb, "Expression: ${tagletpath}", 3 );
4680 append( sb, "", 0 );
4681
4682 append( sb, "taglets", 2 );
4683 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 );
4684 append( sb, "Expression: ${taglets}", 3 );
4685 append( sb, "", 0 );
4686
4687 append( sb, "tags", 2 );
4688 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
4689 append( sb, "Expression: ${tags}", 3 );
4690 append( sb, "", 0 );
4691
4692 append( sb, "testDescription", 2 );
4693 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4694 append( sb, "Expression: ${testDescription}", 3 );
4695 append( sb, "", 0 );
4696
4697 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
4698 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4699 append( sb, "Expression: ${testDoctitle}", 3 );
4700 append( sb, "", 0 );
4701
4702 append( sb, "testJavadocDirectory", 2 );
4703 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
4704 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
4705 append( sb, "", 0 );
4706
4707 append( sb, "testName", 2 );
4708 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4709 append( sb, "Expression: ${testName}", 3 );
4710 append( sb, "", 0 );
4711
4712 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
4713 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
4714 append( sb, "Expression: ${testOverview}", 3 );
4715 append( sb, "", 0 );
4716
4717 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
4718 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4719 append( sb, "Expression: ${testWindowtitle}", 3 );
4720 append( sb, "", 0 );
4721
4722 append( sb, "top", 2 );
4723 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
4724 append( sb, "Expression: ${top}", 3 );
4725 append( sb, "", 0 );
4726
4727 append( sb, "use (Default: true)", 2 );
4728 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
4729 append( sb, "Expression: ${use}", 3 );
4730 append( sb, "", 0 );
4731
4732 append( sb, "useStandardDocletOptions (Default: true)", 2 );
4733 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 );
4734 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
4735 append( sb, "", 0 );
4736
4737 append( sb, "validateLinks (Default: false)", 2 );
4738 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
4739 append( sb, "Expression: ${validateLinks}", 3 );
4740 append( sb, "", 0 );
4741
4742 append( sb, "verbose (Default: false)", 2 );
4743 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
4744 append( sb, "Expression: ${verbose}", 3 );
4745 append( sb, "", 0 );
4746
4747 append( sb, "version (Default: true)", 2 );
4748 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
4749 append( sb, "Expression: ${version}", 3 );
4750 append( sb, "", 0 );
4751
4752 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
4753 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4754 append( sb, "Expression: ${windowtitle}", 3 );
4755 append( sb, "", 0 );
4756 }
4757 }
4758
4759 if ( goal == null || goal.length() <= 0 || "test-resource-bundle".equals( goal ) )
4760 {
4761 append( sb, "javadoc:test-resource-bundle", 0 );
4762 append( sb, "Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from AbstractJavadocMojo such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
4763 append( sb, "", 0 );
4764 if ( detail )
4765 {
4766 append( sb, "Available parameters:", 1 );
4767 append( sb, "", 0 );
4768
4769 append( sb, "additionalJOption", 2 );
4770 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
4771 append( sb, "Expression: ${additionalJOption}", 3 );
4772 append( sb, "", 0 );
4773
4774 append( sb, "additionalparam", 2 );
4775 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 );
4776 append( sb, "Expression: ${additionalparam}", 3 );
4777 append( sb, "", 0 );
4778
4779 append( sb, "additionnalDependencies", 2 );
4780 append( sb, "capability to add optionnal dependencies to the javadoc classpath. Exemple:\n<additionnalDependencies>\n\u00a0\u00a0<additionnalDependency>\n\u00a0\u00a0\u00a0\u00a0<groupId>geronimo-spec</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>geronimo-spec-jta</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0.1B-rc4:</version>\n\u00a0\u00a0</additionnalDependency>\n</additionnalDependencies>\n", 3 );
4781 append( sb, "", 0 );
4782
4783 append( sb, "aggregate (Default: false)", 2 );
4784 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
4785 append( sb, "", 0 );
4786 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
4787 append( sb, "Expression: ${aggregate}", 3 );
4788 append( sb, "", 0 );
4789
4790 append( sb, "author (Default: true)", 2 );
4791 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
4792 append( sb, "Expression: ${author}", 3 );
4793 append( sb, "", 0 );
4794
4795 append( sb, "bootclasspath", 2 );
4796 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
4797 append( sb, "Expression: ${bootclasspath}", 3 );
4798 append( sb, "", 0 );
4799
4800 append( sb, "bootclasspathArtifacts", 2 );
4801 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 );
4802 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
4803 append( sb, "", 0 );
4804
4805 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
4806 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 );
4807 append( sb, "Expression: ${bottom}", 3 );
4808 append( sb, "", 0 );
4809
4810 append( sb, "breakiterator (Default: false)", 2 );
4811 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
4812 append( sb, "Expression: ${breakiterator}", 3 );
4813 append( sb, "", 0 );
4814
4815 append( sb, "charset", 2 );
4816 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 );
4817 append( sb, "Expression: ${charset}", 3 );
4818 append( sb, "", 0 );
4819
4820 append( sb, "debug (Default: false)", 2 );
4821 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
4822 append( sb, "Expression: ${debug}", 3 );
4823 append( sb, "", 0 );
4824
4825 append( sb, "dependencySourceExcludes", 2 );
4826 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
4827 append( sb, "", 0 );
4828
4829 append( sb, "dependencySourceIncludes", 2 );
4830 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
4831 append( sb, "", 0 );
4832
4833 append( sb, "detectJavaApiLink (Default: true)", 2 );
4834 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
4835 append( sb, "Expression: ${detectJavaApiLink}", 3 );
4836 append( sb, "", 0 );
4837
4838 append( sb, "detectLinks (Default: false)", 2 );
4839 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
4840 append( sb, "Expression: ${detectLinks}", 3 );
4841 append( sb, "", 0 );
4842
4843 append( sb, "detectOfflineLinks (Default: true)", 2 );
4844 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
4845 append( sb, "Expression: ${detectOfflineLinks}", 3 );
4846 append( sb, "", 0 );
4847
4848 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
4849 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
4850 append( sb, "Expression: ${docencoding}", 3 );
4851 append( sb, "", 0 );
4852
4853 append( sb, "docfilessubdirs (Default: false)", 2 );
4854 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
4855 append( sb, "Expression: ${docfilessubdirs}", 3 );
4856 append( sb, "", 0 );
4857
4858 append( sb, "doclet", 2 );
4859 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
4860 append( sb, "Expression: ${doclet}", 3 );
4861 append( sb, "", 0 );
4862
4863 append( sb, "docletArtifact", 2 );
4864 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 );
4865 append( sb, "Expression: ${docletArtifact}", 3 );
4866 append( sb, "", 0 );
4867
4868 append( sb, "docletArtifacts", 2 );
4869 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 );
4870 append( sb, "Expression: ${docletArtifacts}", 3 );
4871 append( sb, "", 0 );
4872
4873 append( sb, "docletPath", 2 );
4874 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
4875 append( sb, "Expression: ${docletPath}", 3 );
4876 append( sb, "", 0 );
4877
4878 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
4879 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4880 append( sb, "Expression: ${doctitle}", 3 );
4881 append( sb, "", 0 );
4882
4883 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
4884 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 );
4885 append( sb, "Expression: ${encoding}", 3 );
4886 append( sb, "", 0 );
4887
4888 append( sb, "excludedocfilessubdir", 2 );
4889 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 );
4890 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
4891 append( sb, "", 0 );
4892
4893 append( sb, "excludePackageNames", 2 );
4894 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
4895 append( sb, "Expression: ${excludePackageNames}", 3 );
4896 append( sb, "", 0 );
4897
4898 append( sb, "extdirs", 2 );
4899 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
4900 append( sb, "Expression: ${extdirs}", 3 );
4901 append( sb, "", 0 );
4902
4903 append( sb, "failOnError (Default: true)", 2 );
4904 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
4905 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
4906 append( sb, "", 0 );
4907
4908 append( sb, "footer", 2 );
4909 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
4910 append( sb, "Expression: ${footer}", 3 );
4911 append( sb, "", 0 );
4912
4913 append( sb, "groups", 2 );
4914 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
4915 append( sb, "Expression: ${groups}", 3 );
4916 append( sb, "", 0 );
4917
4918 append( sb, "header", 2 );
4919 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
4920 append( sb, "Expression: ${header}", 3 );
4921 append( sb, "", 0 );
4922
4923 append( sb, "helpfile", 2 );
4924 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
4925 append( sb, "Expression: ${helpfile}", 3 );
4926 append( sb, "", 0 );
4927
4928 append( sb, "includeDependencySources (Default: false)", 2 );
4929 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
4930 append( sb, "", 0 );
4931
4932 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
4933 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
4934 append( sb, "", 0 );
4935
4936 append( sb, "javaApiLinks", 2 );
4937 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
4938 append( sb, "Expression: ${javaApiLinks}", 3 );
4939 append( sb, "", 0 );
4940
4941 append( sb, "javadocDirectory", 2 );
4942 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 );
4943 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
4944 append( sb, "", 0 );
4945
4946 append( sb, "javadocExecutable", 2 );
4947 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 );
4948 append( sb, "Expression: ${javadocExecutable}", 3 );
4949 append( sb, "", 0 );
4950
4951 append( sb, "javadocVersion", 2 );
4952 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
4953 append( sb, "Expression: ${javadocVersion}", 3 );
4954 append( sb, "", 0 );
4955
4956 append( sb, "keywords (Default: false)", 2 );
4957 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 );
4958 append( sb, "Expression: ${keywords}", 3 );
4959 append( sb, "", 0 );
4960
4961 append( sb, "links", 2 );
4962 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
4963 append( sb, "Expression: ${links}", 3 );
4964 append( sb, "", 0 );
4965
4966 append( sb, "linksource (Default: false)", 2 );
4967 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 );
4968 append( sb, "Expression: ${linksource}", 3 );
4969 append( sb, "", 0 );
4970
4971 append( sb, "locale", 2 );
4972 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
4973 append( sb, "Expression: ${locale}", 3 );
4974 append( sb, "", 0 );
4975
4976 append( sb, "localRepository", 2 );
4977 append( sb, "The local repository where the artifacts are located.", 3 );
4978 append( sb, "Expression: ${localRepository}", 3 );
4979 append( sb, "", 0 );
4980
4981 append( sb, "maxmemory", 2 );
4982 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 );
4983 append( sb, "Expression: ${maxmemory}", 3 );
4984 append( sb, "", 0 );
4985
4986 append( sb, "minmemory", 2 );
4987 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 );
4988 append( sb, "Expression: ${minmemory}", 3 );
4989 append( sb, "", 0 );
4990
4991 append( sb, "nocomment (Default: false)", 2 );
4992 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 );
4993 append( sb, "Expression: ${nocomment}", 3 );
4994 append( sb, "", 0 );
4995
4996 append( sb, "nodeprecated (Default: false)", 2 );
4997 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
4998 append( sb, "Expression: ${nodeprecated}", 3 );
4999 append( sb, "", 0 );
5000
5001 append( sb, "nodeprecatedlist (Default: false)", 2 );
5002 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 );
5003 append( sb, "Expression: ${nodeprecatedlist}", 3 );
5004 append( sb, "", 0 );
5005
5006 append( sb, "nohelp (Default: false)", 2 );
5007 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 );
5008 append( sb, "Expression: ${nohelp}", 3 );
5009 append( sb, "", 0 );
5010
5011 append( sb, "noindex (Default: false)", 2 );
5012 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
5013 append( sb, "Expression: ${noindex}", 3 );
5014 append( sb, "", 0 );
5015
5016 append( sb, "nonavbar (Default: false)", 2 );
5017 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
5018 append( sb, "Expression: ${nonavbar}", 3 );
5019 append( sb, "", 0 );
5020
5021 append( sb, "nooverview (Default: false)", 2 );
5022 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
5023 append( sb, "Expression: ${nooverview}", 3 );
5024 append( sb, "", 0 );
5025
5026 append( sb, "noqualifier", 2 );
5027 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
5028 append( sb, "Expression: ${noqualifier}", 3 );
5029 append( sb, "", 0 );
5030
5031 append( sb, "nosince (Default: false)", 2 );
5032 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
5033 append( sb, "Expression: ${nosince}", 3 );
5034 append( sb, "", 0 );
5035
5036 append( sb, "notimestamp (Default: false)", 2 );
5037 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 );
5038 append( sb, "Expression: ${notimestamp}", 3 );
5039 append( sb, "", 0 );
5040
5041 append( sb, "notree (Default: false)", 2 );
5042 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
5043 append( sb, "Expression: ${notree}", 3 );
5044 append( sb, "", 0 );
5045
5046 append( sb, "offlineLinks", 2 );
5047 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
5048 append( sb, "Expression: ${offlineLinks}", 3 );
5049 append( sb, "", 0 );
5050
5051 append( sb, "old (Default: false)", 2 );
5052 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
5053 append( sb, "Expression: ${old}", 3 );
5054 append( sb, "", 0 );
5055
5056 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
5057 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
5058 append( sb, "Required: Yes", 3 );
5059 append( sb, "Expression: ${destDir}", 3 );
5060 append( sb, "", 0 );
5061
5062 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
5063 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 );
5064 append( sb, "Expression: ${overview}", 3 );
5065 append( sb, "", 0 );
5066
5067 append( sb, "packagesheader", 2 );
5068 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
5069 append( sb, "Expression: ${packagesheader}", 3 );
5070 append( sb, "", 0 );
5071
5072 append( sb, "proxyHost", 2 );
5073 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
5074 append( sb, "", 0 );
5075 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 );
5076 append( sb, "Expression: ${proxyHost}", 3 );
5077 append( sb, "", 0 );
5078
5079 append( sb, "proxyPort", 2 );
5080 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
5081 append( sb, "", 0 );
5082 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 );
5083 append( sb, "Expression: ${proxyPort}", 3 );
5084 append( sb, "", 0 );
5085
5086 append( sb, "quiet (Default: false)", 2 );
5087 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 );
5088 append( sb, "Expression: ${quiet}", 3 );
5089 append( sb, "", 0 );
5090
5091 append( sb, "remoteRepositories", 2 );
5092 append( sb, "The remote repositories where artifacts are located.", 3 );
5093 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
5094 append( sb, "", 0 );
5095
5096 append( sb, "resourcesArtifacts", 2 );
5097 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 );
5098 append( sb, "Expression: ${resourcesArtifacts}", 3 );
5099 append( sb, "", 0 );
5100
5101 append( sb, "serialwarn (Default: false)", 2 );
5102 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
5103 append( sb, "Expression: ${serialwarn}", 3 );
5104 append( sb, "", 0 );
5105
5106 append( sb, "show (Default: protected)", 2 );
5107 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 );
5108 append( sb, "Expression: ${show}", 3 );
5109 append( sb, "", 0 );
5110
5111 append( sb, "skip (Default: false)", 2 );
5112 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
5113 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
5114 append( sb, "", 0 );
5115
5116 append( sb, "source", 2 );
5117 append( sb, "Necessary to enable javadoc to handle assertions introduced in J2SE v 1.4 source code or generics introduced in J2SE v5.\nSee source.\nSince Java 1.4.", 3 );
5118 append( sb, "Expression: ${source}", 3 );
5119 append( sb, "", 0 );
5120
5121 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
5122 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
5123 append( sb, "", 0 );
5124
5125 append( sb, "sourcepath", 2 );
5126 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
5127 append( sb, "Expression: ${sourcepath}", 3 );
5128 append( sb, "", 0 );
5129
5130 append( sb, "sourcetab", 2 );
5131 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 );
5132 append( sb, "Expression: ${sourcetab}", 3 );
5133 append( sb, "", 0 );
5134
5135 append( sb, "splitindex (Default: false)", 2 );
5136 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 );
5137 append( sb, "Expression: ${splitindex}", 3 );
5138 append( sb, "", 0 );
5139
5140 append( sb, "stylesheet (Default: java)", 2 );
5141 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
5142 append( sb, "Expression: ${stylesheet}", 3 );
5143 append( sb, "", 0 );
5144
5145 append( sb, "stylesheetfile", 2 );
5146 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
5147 append( sb, "Expression: ${stylesheetfile}", 3 );
5148 append( sb, "", 0 );
5149
5150 append( sb, "subpackages", 2 );
5151 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 );
5152 append( sb, "Expression: ${subpackages}", 3 );
5153 append( sb, "", 0 );
5154
5155 append( sb, "taglet", 2 );
5156 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 );
5157 append( sb, "Expression: ${taglet}", 3 );
5158 append( sb, "", 0 );
5159
5160 append( sb, "tagletArtifact", 2 );
5161 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 );
5162 append( sb, "Expression: ${tagletArtifact}", 3 );
5163 append( sb, "", 0 );
5164
5165 append( sb, "tagletArtifacts", 2 );
5166 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 );
5167 append( sb, "Expression: ${tagletArtifacts}", 3 );
5168 append( sb, "", 0 );
5169
5170 append( sb, "tagletpath", 2 );
5171 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
5172 append( sb, "Expression: ${tagletpath}", 3 );
5173 append( sb, "", 0 );
5174
5175 append( sb, "taglets", 2 );
5176 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 );
5177 append( sb, "Expression: ${taglets}", 3 );
5178 append( sb, "", 0 );
5179
5180 append( sb, "tags", 2 );
5181 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
5182 append( sb, "Expression: ${tags}", 3 );
5183 append( sb, "", 0 );
5184
5185 append( sb, "testJavadocDirectory (Default: ${basedir}/src/test/javadoc)", 2 );
5186 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
5187 append( sb, "", 0 );
5188
5189 append( sb, "top", 2 );
5190 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
5191 append( sb, "Expression: ${top}", 3 );
5192 append( sb, "", 0 );
5193
5194 append( sb, "use (Default: true)", 2 );
5195 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
5196 append( sb, "Expression: ${use}", 3 );
5197 append( sb, "", 0 );
5198
5199 append( sb, "useStandardDocletOptions (Default: true)", 2 );
5200 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 );
5201 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
5202 append( sb, "", 0 );
5203
5204 append( sb, "validateLinks (Default: false)", 2 );
5205 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
5206 append( sb, "Expression: ${validateLinks}", 3 );
5207 append( sb, "", 0 );
5208
5209 append( sb, "verbose (Default: false)", 2 );
5210 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
5211 append( sb, "Expression: ${verbose}", 3 );
5212 append( sb, "", 0 );
5213
5214 append( sb, "version (Default: true)", 2 );
5215 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
5216 append( sb, "Expression: ${version}", 3 );
5217 append( sb, "", 0 );
5218
5219 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
5220 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
5221 append( sb, "Expression: ${windowtitle}", 3 );
5222 append( sb, "", 0 );
5223 }
5224 }
5225
5226 if ( getLog().isInfoEnabled() )
5227 {
5228 getLog().info( sb.toString() );
5229 }
5230 }
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241 private static String repeat( String str, int repeat )
5242 {
5243 StringBuffer buffer = new StringBuffer( repeat * str.length() );
5244
5245 for ( int i = 0; i < repeat; i++ )
5246 {
5247 buffer.append( str );
5248 }
5249
5250 return buffer.toString();
5251 }
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261 private void append( StringBuffer sb, String description, int indent )
5262 {
5263 for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
5264 {
5265 sb.append( it.next().toString() ).append( '\n' );
5266 }
5267 }
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279 private static List toLines( String text, int indent, int indentSize, int lineLength )
5280 {
5281 List<String> lines = new ArrayList<String>();
5282
5283 String ind = repeat( "\t", indent );
5284 String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
5285 for ( int i = 0; i < plainLines.length; i++ )
5286 {
5287 toLines( lines, ind + plainLines[i], indentSize, lineLength );
5288 }
5289
5290 return lines;
5291 }
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301 private static void toLines( List<String> lines, String line, int indentSize, int lineLength )
5302 {
5303 int lineIndent = getIndentLevel( line );
5304 StringBuffer buf = new StringBuffer( 256 );
5305 String[] tokens = line.split( " +" );
5306 for ( int i = 0; i < tokens.length; i++ )
5307 {
5308 String token = tokens[i];
5309 if ( i > 0 )
5310 {
5311 if ( buf.length() + token.length() >= lineLength )
5312 {
5313 lines.add( buf.toString() );
5314 buf.setLength( 0 );
5315 buf.append( repeat( " ", lineIndent * indentSize ) );
5316 }
5317 else
5318 {
5319 buf.append( ' ' );
5320 }
5321 }
5322 for ( int j = 0; j < token.length(); j++ )
5323 {
5324 char c = token.charAt( j );
5325 if ( c == '\t' )
5326 {
5327 buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
5328 }
5329 else if ( c == '\u00A0' )
5330 {
5331 buf.append( ' ' );
5332 }
5333 else
5334 {
5335 buf.append( c );
5336 }
5337 }
5338 }
5339 lines.add( buf.toString() );
5340 }
5341
5342
5343
5344
5345
5346
5347
5348 private static int getIndentLevel( String line )
5349 {
5350 int level = 0;
5351 for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
5352 {
5353 level++;
5354 }
5355 for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
5356 {
5357 if ( line.charAt( i ) == '\t' )
5358 {
5359 level++;
5360 break;
5361 }
5362 }
5363 return level;
5364 }
5365 }