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 public class HelpMojo
20 extends AbstractMojo
21 {
22
23
24
25
26
27 private boolean detail;
28
29
30
31
32
33
34 private java.lang.String goal;
35
36
37
38
39
40
41 private int lineLength;
42
43
44
45
46
47
48 private int indentSize;
49
50
51
52 public void execute()
53 throws MojoExecutionException
54 {
55 if ( lineLength <= 0 )
56 {
57 getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." );
58 lineLength = 80;
59 }
60 if ( indentSize <= 0 )
61 {
62 getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." );
63 indentSize = 2;
64 }
65
66 StringBuffer sb = new StringBuffer();
67
68 append( sb, "org.apache.maven.plugins:maven-javadoc-plugin:2.8", 0 );
69 append( sb, "", 0 );
70
71 append( sb, "Maven Javadoc Plugin", 0 );
72 append( sb, "The Maven Javadoc Plugin is a plugin that uses the javadoc tool for generating javadocs for the specified project.", 1 );
73 append( sb, "", 0 );
74
75 if ( goal == null || goal.length() <= 0 )
76 {
77 append( sb, "This plugin has 13 goals:", 0 );
78 append( sb, "", 0 );
79 }
80
81 if ( goal == null || goal.length() <= 0 || "aggregate".equals( goal ) )
82 {
83 append( sb, "javadoc:aggregate", 0 );
84 append( sb, "Generates documentation for the Java code in an aggregator project using the standard Javadoc Tool.", 1 );
85 append( sb, "", 0 );
86 if ( detail )
87 {
88 append( sb, "Available parameters:", 1 );
89 append( sb, "", 0 );
90
91 append( sb, "additionalJOption", 2 );
92 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
93 append( sb, "Expression: ${additionalJOption}", 3 );
94 append( sb, "", 0 );
95
96 append( sb, "additionalparam", 2 );
97 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
98 append( sb, "Expression: ${additionalparam}", 3 );
99 append( sb, "", 0 );
100
101 append( sb, "aggregate (Default: false)", 2 );
102 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
103 append( sb, "", 0 );
104 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
105 append( sb, "Expression: ${aggregate}", 3 );
106 append( sb, "", 0 );
107
108 append( sb, "author (Default: true)", 2 );
109 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
110 append( sb, "Expression: ${author}", 3 );
111 append( sb, "", 0 );
112
113 append( sb, "bootclasspath", 2 );
114 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
115 append( sb, "Expression: ${bootclasspath}", 3 );
116 append( sb, "", 0 );
117
118 append( sb, "bootclasspathArtifacts", 2 );
119 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
120 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
121 append( sb, "", 0 );
122
123 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
124 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
125 append( sb, "Expression: ${bottom}", 3 );
126 append( sb, "", 0 );
127
128 append( sb, "breakiterator (Default: false)", 2 );
129 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
130 append( sb, "Expression: ${breakiterator}", 3 );
131 append( sb, "", 0 );
132
133 append( sb, "charset", 2 );
134 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
135 append( sb, "Expression: ${charset}", 3 );
136 append( sb, "", 0 );
137
138 append( sb, "debug (Default: false)", 2 );
139 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
140 append( sb, "Expression: ${debug}", 3 );
141 append( sb, "", 0 );
142
143 append( sb, "dependencySourceExcludes", 2 );
144 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
145 append( sb, "", 0 );
146
147 append( sb, "dependencySourceIncludes", 2 );
148 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
149 append( sb, "", 0 );
150
151 append( sb, "description", 2 );
152 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
153 append( sb, "Expression: ${description}", 3 );
154 append( sb, "", 0 );
155
156 append( sb, "destDir (Default: apidocs)", 2 );
157 append( sb, "The name of the destination directory.\n", 3 );
158 append( sb, "Expression: ${destDir}", 3 );
159 append( sb, "", 0 );
160
161 append( sb, "detectJavaApiLink (Default: true)", 2 );
162 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
163 append( sb, "Expression: ${detectJavaApiLink}", 3 );
164 append( sb, "", 0 );
165
166 append( sb, "detectLinks (Default: false)", 2 );
167 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
168 append( sb, "Expression: ${detectLinks}", 3 );
169 append( sb, "", 0 );
170
171 append( sb, "detectOfflineLinks (Default: true)", 2 );
172 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
173 append( sb, "Expression: ${detectOfflineLinks}", 3 );
174 append( sb, "", 0 );
175
176 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
177 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
178 append( sb, "Expression: ${docencoding}", 3 );
179 append( sb, "", 0 );
180
181 append( sb, "docfilessubdirs (Default: false)", 2 );
182 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
183 append( sb, "Expression: ${docfilessubdirs}", 3 );
184 append( sb, "", 0 );
185
186 append( sb, "doclet", 2 );
187 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
188 append( sb, "Expression: ${doclet}", 3 );
189 append( sb, "", 0 );
190
191 append( sb, "docletArtifact", 2 );
192 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
193 append( sb, "Expression: ${docletArtifact}", 3 );
194 append( sb, "", 0 );
195
196 append( sb, "docletArtifacts", 2 );
197 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
198 append( sb, "Expression: ${docletArtifacts}", 3 );
199 append( sb, "", 0 );
200
201 append( sb, "docletPath", 2 );
202 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
203 append( sb, "Expression: ${docletPath}", 3 );
204 append( sb, "", 0 );
205
206 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
207 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
208 append( sb, "Expression: ${doctitle}", 3 );
209 append( sb, "", 0 );
210
211 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
212 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
213 append( sb, "Expression: ${encoding}", 3 );
214 append( sb, "", 0 );
215
216 append( sb, "excludedocfilessubdir", 2 );
217 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
218 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
219 append( sb, "", 0 );
220
221 append( sb, "excludePackageNames", 2 );
222 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
223 append( sb, "Expression: ${excludePackageNames}", 3 );
224 append( sb, "", 0 );
225
226 append( sb, "extdirs", 2 );
227 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
228 append( sb, "Expression: ${extdirs}", 3 );
229 append( sb, "", 0 );
230
231 append( sb, "failOnError (Default: true)", 2 );
232 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
233 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
234 append( sb, "", 0 );
235
236 append( sb, "footer", 2 );
237 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
238 append( sb, "Expression: ${footer}", 3 );
239 append( sb, "", 0 );
240
241 append( sb, "groups", 2 );
242 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
243 append( sb, "Expression: ${groups}", 3 );
244 append( sb, "", 0 );
245
246 append( sb, "header", 2 );
247 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
248 append( sb, "Expression: ${header}", 3 );
249 append( sb, "", 0 );
250
251 append( sb, "helpfile", 2 );
252 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
253 append( sb, "Expression: ${helpfile}", 3 );
254 append( sb, "", 0 );
255
256 append( sb, "includeDependencySources (Default: false)", 2 );
257 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
258 append( sb, "", 0 );
259
260 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
261 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
262 append( sb, "", 0 );
263
264 append( sb, "javaApiLinks", 2 );
265 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
266 append( sb, "Expression: ${javaApiLinks}", 3 );
267 append( sb, "", 0 );
268
269 append( sb, "javadocDirectory", 2 );
270 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
271 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
272 append( sb, "", 0 );
273
274 append( sb, "javadocExecutable", 2 );
275 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
276 append( sb, "Expression: ${javadocExecutable}", 3 );
277 append( sb, "", 0 );
278
279 append( sb, "javadocVersion", 2 );
280 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
281 append( sb, "Expression: ${javadocVersion}", 3 );
282 append( sb, "", 0 );
283
284 append( sb, "keywords (Default: false)", 2 );
285 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
286 append( sb, "Expression: ${keywords}", 3 );
287 append( sb, "", 0 );
288
289 append( sb, "links", 2 );
290 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
291 append( sb, "Expression: ${links}", 3 );
292 append( sb, "", 0 );
293
294 append( sb, "linksource (Default: false)", 2 );
295 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
296 append( sb, "Expression: ${linksource}", 3 );
297 append( sb, "", 0 );
298
299 append( sb, "locale", 2 );
300 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
301 append( sb, "Expression: ${locale}", 3 );
302 append( sb, "", 0 );
303
304 append( sb, "localRepository", 2 );
305 append( sb, "The local repository where the artifacts are located.", 3 );
306 append( sb, "Expression: ${localRepository}", 3 );
307 append( sb, "", 0 );
308
309 append( sb, "maxmemory", 2 );
310 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
311 append( sb, "Expression: ${maxmemory}", 3 );
312 append( sb, "", 0 );
313
314 append( sb, "minmemory", 2 );
315 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
316 append( sb, "Expression: ${minmemory}", 3 );
317 append( sb, "", 0 );
318
319 append( sb, "name", 2 );
320 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
321 append( sb, "Expression: ${name}", 3 );
322 append( sb, "", 0 );
323
324 append( sb, "nocomment (Default: false)", 2 );
325 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
326 append( sb, "Expression: ${nocomment}", 3 );
327 append( sb, "", 0 );
328
329 append( sb, "nodeprecated (Default: false)", 2 );
330 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
331 append( sb, "Expression: ${nodeprecated}", 3 );
332 append( sb, "", 0 );
333
334 append( sb, "nodeprecatedlist (Default: false)", 2 );
335 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
336 append( sb, "Expression: ${nodeprecatedlist}", 3 );
337 append( sb, "", 0 );
338
339 append( sb, "nohelp (Default: false)", 2 );
340 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
341 append( sb, "Expression: ${nohelp}", 3 );
342 append( sb, "", 0 );
343
344 append( sb, "noindex (Default: false)", 2 );
345 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
346 append( sb, "Expression: ${noindex}", 3 );
347 append( sb, "", 0 );
348
349 append( sb, "nonavbar (Default: false)", 2 );
350 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
351 append( sb, "Expression: ${nonavbar}", 3 );
352 append( sb, "", 0 );
353
354 append( sb, "nooverview (Default: false)", 2 );
355 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
356 append( sb, "Expression: ${nooverview}", 3 );
357 append( sb, "", 0 );
358
359 append( sb, "noqualifier", 2 );
360 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
361 append( sb, "Expression: ${noqualifier}", 3 );
362 append( sb, "", 0 );
363
364 append( sb, "nosince (Default: false)", 2 );
365 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
366 append( sb, "Expression: ${nosince}", 3 );
367 append( sb, "", 0 );
368
369 append( sb, "notimestamp (Default: false)", 2 );
370 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
371 append( sb, "Expression: ${notimestamp}", 3 );
372 append( sb, "", 0 );
373
374 append( sb, "notree (Default: false)", 2 );
375 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
376 append( sb, "Expression: ${notree}", 3 );
377 append( sb, "", 0 );
378
379 append( sb, "offlineLinks", 2 );
380 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
381 append( sb, "Expression: ${offlineLinks}", 3 );
382 append( sb, "", 0 );
383
384 append( sb, "old (Default: false)", 2 );
385 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
386 append( sb, "Expression: ${old}", 3 );
387 append( sb, "", 0 );
388
389 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
390 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
391 append( sb, "Required: Yes", 3 );
392 append( sb, "Expression: ${destDir}", 3 );
393 append( sb, "", 0 );
394
395 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
396 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
397 append( sb, "Expression: ${overview}", 3 );
398 append( sb, "", 0 );
399
400 append( sb, "packagesheader", 2 );
401 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
402 append( sb, "Expression: ${packagesheader}", 3 );
403 append( sb, "", 0 );
404
405 append( sb, "proxyHost", 2 );
406 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
407 append( sb, "", 0 );
408 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
409 append( sb, "Expression: ${proxyHost}", 3 );
410 append( sb, "", 0 );
411
412 append( sb, "proxyPort", 2 );
413 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
414 append( sb, "", 0 );
415 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
416 append( sb, "Expression: ${proxyPort}", 3 );
417 append( sb, "", 0 );
418
419 append( sb, "quiet (Default: false)", 2 );
420 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
421 append( sb, "Expression: ${quiet}", 3 );
422 append( sb, "", 0 );
423
424 append( sb, "remoteRepositories", 2 );
425 append( sb, "The remote repositories where artifacts are located.", 3 );
426 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
427 append( sb, "", 0 );
428
429 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
430 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
431 append( sb, "Required: Yes", 3 );
432 append( sb, "Expression: ${reportOutputDirectory}", 3 );
433 append( sb, "", 0 );
434
435 append( sb, "resourcesArtifacts", 2 );
436 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
437 append( sb, "Expression: ${resourcesArtifacts}", 3 );
438 append( sb, "", 0 );
439
440 append( sb, "serialwarn (Default: false)", 2 );
441 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
442 append( sb, "Expression: ${serialwarn}", 3 );
443 append( sb, "", 0 );
444
445 append( sb, "show (Default: protected)", 2 );
446 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
447 append( sb, "Expression: ${show}", 3 );
448 append( sb, "", 0 );
449
450 append( sb, "skip (Default: false)", 2 );
451 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
452 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
453 append( sb, "", 0 );
454
455 append( sb, "source", 2 );
456 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
457 append( sb, "Expression: ${source}", 3 );
458 append( sb, "", 0 );
459
460 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
461 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
462 append( sb, "", 0 );
463
464 append( sb, "sourcepath", 2 );
465 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
466 append( sb, "Expression: ${sourcepath}", 3 );
467 append( sb, "", 0 );
468
469 append( sb, "sourcetab", 2 );
470 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
471 append( sb, "Expression: ${sourcetab}", 3 );
472 append( sb, "", 0 );
473
474 append( sb, "splitindex (Default: false)", 2 );
475 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
476 append( sb, "Expression: ${splitindex}", 3 );
477 append( sb, "", 0 );
478
479 append( sb, "stylesheet (Default: java)", 2 );
480 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
481 append( sb, "Expression: ${stylesheet}", 3 );
482 append( sb, "", 0 );
483
484 append( sb, "stylesheetfile", 2 );
485 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
486 append( sb, "Expression: ${stylesheetfile}", 3 );
487 append( sb, "", 0 );
488
489 append( sb, "subpackages", 2 );
490 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
491 append( sb, "Expression: ${subpackages}", 3 );
492 append( sb, "", 0 );
493
494 append( sb, "taglet", 2 );
495 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
496 append( sb, "Expression: ${taglet}", 3 );
497 append( sb, "", 0 );
498
499 append( sb, "tagletArtifact", 2 );
500 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
501 append( sb, "Expression: ${tagletArtifact}", 3 );
502 append( sb, "", 0 );
503
504 append( sb, "tagletArtifacts", 2 );
505 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
506 append( sb, "Expression: ${tagletArtifacts}", 3 );
507 append( sb, "", 0 );
508
509 append( sb, "tagletpath", 2 );
510 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
511 append( sb, "Expression: ${tagletpath}", 3 );
512 append( sb, "", 0 );
513
514 append( sb, "taglets", 2 );
515 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
516 append( sb, "Expression: ${taglets}", 3 );
517 append( sb, "", 0 );
518
519 append( sb, "tags", 2 );
520 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
521 append( sb, "Expression: ${tags}", 3 );
522 append( sb, "", 0 );
523
524 append( sb, "top", 2 );
525 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
526 append( sb, "Expression: ${top}", 3 );
527 append( sb, "", 0 );
528
529 append( sb, "use (Default: true)", 2 );
530 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
531 append( sb, "Expression: ${use}", 3 );
532 append( sb, "", 0 );
533
534 append( sb, "useStandardDocletOptions (Default: true)", 2 );
535 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
536 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
537 append( sb, "", 0 );
538
539 append( sb, "validateLinks (Default: false)", 2 );
540 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
541 append( sb, "Expression: ${validateLinks}", 3 );
542 append( sb, "", 0 );
543
544 append( sb, "verbose (Default: false)", 2 );
545 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
546 append( sb, "Expression: ${verbose}", 3 );
547 append( sb, "", 0 );
548
549 append( sb, "version (Default: true)", 2 );
550 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
551 append( sb, "Expression: ${version}", 3 );
552 append( sb, "", 0 );
553
554 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
555 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
556 append( sb, "Expression: ${windowtitle}", 3 );
557 append( sb, "", 0 );
558 }
559 }
560
561 if ( goal == null || goal.length() <= 0 || "aggregate-jar".equals( goal ) )
562 {
563 append( sb, "javadoc:aggregate-jar", 0 );
564 append( sb, "Bundles the Javadoc documentation for main Java code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
565 append( sb, "", 0 );
566 if ( detail )
567 {
568 append( sb, "Available parameters:", 1 );
569 append( sb, "", 0 );
570
571 append( sb, "additionalJOption", 2 );
572 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
573 append( sb, "Expression: ${additionalJOption}", 3 );
574 append( sb, "", 0 );
575
576 append( sb, "additionalparam", 2 );
577 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
578 append( sb, "Expression: ${additionalparam}", 3 );
579 append( sb, "", 0 );
580
581 append( sb, "aggregate (Default: false)", 2 );
582 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
583 append( sb, "", 0 );
584 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
585 append( sb, "Expression: ${aggregate}", 3 );
586 append( sb, "", 0 );
587
588 append( sb, "archive", 2 );
589 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
590 append( sb, "", 0 );
591
592 append( sb, "attach (Default: true)", 2 );
593 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
594 append( sb, "Expression: ${attach}", 3 );
595 append( sb, "", 0 );
596
597 append( sb, "author (Default: true)", 2 );
598 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
599 append( sb, "Expression: ${author}", 3 );
600 append( sb, "", 0 );
601
602 append( sb, "bootclasspath", 2 );
603 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
604 append( sb, "Expression: ${bootclasspath}", 3 );
605 append( sb, "", 0 );
606
607 append( sb, "bootclasspathArtifacts", 2 );
608 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
609 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
610 append( sb, "", 0 );
611
612 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
613 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
614 append( sb, "Expression: ${bottom}", 3 );
615 append( sb, "", 0 );
616
617 append( sb, "breakiterator (Default: false)", 2 );
618 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
619 append( sb, "Expression: ${breakiterator}", 3 );
620 append( sb, "", 0 );
621
622 append( sb, "charset", 2 );
623 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
624 append( sb, "Expression: ${charset}", 3 );
625 append( sb, "", 0 );
626
627 append( sb, "debug (Default: false)", 2 );
628 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
629 append( sb, "Expression: ${debug}", 3 );
630 append( sb, "", 0 );
631
632 append( sb, "dependencySourceExcludes", 2 );
633 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
634 append( sb, "", 0 );
635
636 append( sb, "dependencySourceIncludes", 2 );
637 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
638 append( sb, "", 0 );
639
640 append( sb, "destDir", 2 );
641 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
642 append( sb, "Expression: ${destDir}", 3 );
643 append( sb, "", 0 );
644
645 append( sb, "detectJavaApiLink (Default: true)", 2 );
646 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
647 append( sb, "Expression: ${detectJavaApiLink}", 3 );
648 append( sb, "", 0 );
649
650 append( sb, "detectLinks (Default: false)", 2 );
651 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
652 append( sb, "Expression: ${detectLinks}", 3 );
653 append( sb, "", 0 );
654
655 append( sb, "detectOfflineLinks (Default: true)", 2 );
656 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
657 append( sb, "Expression: ${detectOfflineLinks}", 3 );
658 append( sb, "", 0 );
659
660 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
661 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
662 append( sb, "Expression: ${docencoding}", 3 );
663 append( sb, "", 0 );
664
665 append( sb, "docfilessubdirs (Default: false)", 2 );
666 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
667 append( sb, "Expression: ${docfilessubdirs}", 3 );
668 append( sb, "", 0 );
669
670 append( sb, "doclet", 2 );
671 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
672 append( sb, "Expression: ${doclet}", 3 );
673 append( sb, "", 0 );
674
675 append( sb, "docletArtifact", 2 );
676 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
677 append( sb, "Expression: ${docletArtifact}", 3 );
678 append( sb, "", 0 );
679
680 append( sb, "docletArtifacts", 2 );
681 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
682 append( sb, "Expression: ${docletArtifacts}", 3 );
683 append( sb, "", 0 );
684
685 append( sb, "docletPath", 2 );
686 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
687 append( sb, "Expression: ${docletPath}", 3 );
688 append( sb, "", 0 );
689
690 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
691 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
692 append( sb, "Expression: ${doctitle}", 3 );
693 append( sb, "", 0 );
694
695 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
696 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
697 append( sb, "Expression: ${encoding}", 3 );
698 append( sb, "", 0 );
699
700 append( sb, "excludedocfilessubdir", 2 );
701 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
702 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
703 append( sb, "", 0 );
704
705 append( sb, "excludePackageNames", 2 );
706 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
707 append( sb, "Expression: ${excludePackageNames}", 3 );
708 append( sb, "", 0 );
709
710 append( sb, "extdirs", 2 );
711 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
712 append( sb, "Expression: ${extdirs}", 3 );
713 append( sb, "", 0 );
714
715 append( sb, "failOnError (Default: true)", 2 );
716 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
717 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
718 append( sb, "", 0 );
719
720 append( sb, "finalName", 2 );
721 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
722 append( sb, "Expression: ${project.build.finalName}", 3 );
723 append( sb, "", 0 );
724
725 append( sb, "footer", 2 );
726 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
727 append( sb, "Expression: ${footer}", 3 );
728 append( sb, "", 0 );
729
730 append( sb, "groups", 2 );
731 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
732 append( sb, "Expression: ${groups}", 3 );
733 append( sb, "", 0 );
734
735 append( sb, "header", 2 );
736 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
737 append( sb, "Expression: ${header}", 3 );
738 append( sb, "", 0 );
739
740 append( sb, "helpfile", 2 );
741 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
742 append( sb, "Expression: ${helpfile}", 3 );
743 append( sb, "", 0 );
744
745 append( sb, "includeDependencySources (Default: false)", 2 );
746 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
747 append( sb, "", 0 );
748
749 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
750 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
751 append( sb, "", 0 );
752
753 append( sb, "jarOutputDirectory", 2 );
754 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
755 append( sb, "Expression: ${project.build.directory}", 3 );
756 append( sb, "", 0 );
757
758 append( sb, "javaApiLinks", 2 );
759 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
760 append( sb, "Expression: ${javaApiLinks}", 3 );
761 append( sb, "", 0 );
762
763 append( sb, "javadocDirectory", 2 );
764 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
765 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
766 append( sb, "", 0 );
767
768 append( sb, "javadocExecutable", 2 );
769 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
770 append( sb, "Expression: ${javadocExecutable}", 3 );
771 append( sb, "", 0 );
772
773 append( sb, "javadocVersion", 2 );
774 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
775 append( sb, "Expression: ${javadocVersion}", 3 );
776 append( sb, "", 0 );
777
778 append( sb, "keywords (Default: false)", 2 );
779 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
780 append( sb, "Expression: ${keywords}", 3 );
781 append( sb, "", 0 );
782
783 append( sb, "links", 2 );
784 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
785 append( sb, "Expression: ${links}", 3 );
786 append( sb, "", 0 );
787
788 append( sb, "linksource (Default: false)", 2 );
789 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
790 append( sb, "Expression: ${linksource}", 3 );
791 append( sb, "", 0 );
792
793 append( sb, "locale", 2 );
794 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
795 append( sb, "Expression: ${locale}", 3 );
796 append( sb, "", 0 );
797
798 append( sb, "localRepository", 2 );
799 append( sb, "The local repository where the artifacts are located.", 3 );
800 append( sb, "Expression: ${localRepository}", 3 );
801 append( sb, "", 0 );
802
803 append( sb, "maxmemory", 2 );
804 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
805 append( sb, "Expression: ${maxmemory}", 3 );
806 append( sb, "", 0 );
807
808 append( sb, "minmemory", 2 );
809 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
810 append( sb, "Expression: ${minmemory}", 3 );
811 append( sb, "", 0 );
812
813 append( sb, "nocomment (Default: false)", 2 );
814 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
815 append( sb, "Expression: ${nocomment}", 3 );
816 append( sb, "", 0 );
817
818 append( sb, "nodeprecated (Default: false)", 2 );
819 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
820 append( sb, "Expression: ${nodeprecated}", 3 );
821 append( sb, "", 0 );
822
823 append( sb, "nodeprecatedlist (Default: false)", 2 );
824 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
825 append( sb, "Expression: ${nodeprecatedlist}", 3 );
826 append( sb, "", 0 );
827
828 append( sb, "nohelp (Default: false)", 2 );
829 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
830 append( sb, "Expression: ${nohelp}", 3 );
831 append( sb, "", 0 );
832
833 append( sb, "noindex (Default: false)", 2 );
834 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
835 append( sb, "Expression: ${noindex}", 3 );
836 append( sb, "", 0 );
837
838 append( sb, "nonavbar (Default: false)", 2 );
839 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
840 append( sb, "Expression: ${nonavbar}", 3 );
841 append( sb, "", 0 );
842
843 append( sb, "nooverview (Default: false)", 2 );
844 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
845 append( sb, "Expression: ${nooverview}", 3 );
846 append( sb, "", 0 );
847
848 append( sb, "noqualifier", 2 );
849 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
850 append( sb, "Expression: ${noqualifier}", 3 );
851 append( sb, "", 0 );
852
853 append( sb, "nosince (Default: false)", 2 );
854 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
855 append( sb, "Expression: ${nosince}", 3 );
856 append( sb, "", 0 );
857
858 append( sb, "notimestamp (Default: false)", 2 );
859 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
860 append( sb, "Expression: ${notimestamp}", 3 );
861 append( sb, "", 0 );
862
863 append( sb, "notree (Default: false)", 2 );
864 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
865 append( sb, "Expression: ${notree}", 3 );
866 append( sb, "", 0 );
867
868 append( sb, "offlineLinks", 2 );
869 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
870 append( sb, "Expression: ${offlineLinks}", 3 );
871 append( sb, "", 0 );
872
873 append( sb, "old (Default: false)", 2 );
874 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
875 append( sb, "Expression: ${old}", 3 );
876 append( sb, "", 0 );
877
878 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
879 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
880 append( sb, "Required: Yes", 3 );
881 append( sb, "Expression: ${destDir}", 3 );
882 append( sb, "", 0 );
883
884 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
885 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
886 append( sb, "Expression: ${overview}", 3 );
887 append( sb, "", 0 );
888
889 append( sb, "packagesheader", 2 );
890 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
891 append( sb, "Expression: ${packagesheader}", 3 );
892 append( sb, "", 0 );
893
894 append( sb, "proxyHost", 2 );
895 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
896 append( sb, "", 0 );
897 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
898 append( sb, "Expression: ${proxyHost}", 3 );
899 append( sb, "", 0 );
900
901 append( sb, "proxyPort", 2 );
902 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
903 append( sb, "", 0 );
904 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
905 append( sb, "Expression: ${proxyPort}", 3 );
906 append( sb, "", 0 );
907
908 append( sb, "quiet (Default: false)", 2 );
909 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
910 append( sb, "Expression: ${quiet}", 3 );
911 append( sb, "", 0 );
912
913 append( sb, "remoteRepositories", 2 );
914 append( sb, "The remote repositories where artifacts are located.", 3 );
915 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
916 append( sb, "", 0 );
917
918 append( sb, "resourcesArtifacts", 2 );
919 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
920 append( sb, "Expression: ${resourcesArtifacts}", 3 );
921 append( sb, "", 0 );
922
923 append( sb, "serialwarn (Default: false)", 2 );
924 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
925 append( sb, "Expression: ${serialwarn}", 3 );
926 append( sb, "", 0 );
927
928 append( sb, "show (Default: protected)", 2 );
929 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
930 append( sb, "Expression: ${show}", 3 );
931 append( sb, "", 0 );
932
933 append( sb, "skip (Default: false)", 2 );
934 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
935 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
936 append( sb, "", 0 );
937
938 append( sb, "source", 2 );
939 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
940 append( sb, "Expression: ${source}", 3 );
941 append( sb, "", 0 );
942
943 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
944 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
945 append( sb, "", 0 );
946
947 append( sb, "sourcepath", 2 );
948 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
949 append( sb, "Expression: ${sourcepath}", 3 );
950 append( sb, "", 0 );
951
952 append( sb, "sourcetab", 2 );
953 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
954 append( sb, "Expression: ${sourcetab}", 3 );
955 append( sb, "", 0 );
956
957 append( sb, "splitindex (Default: false)", 2 );
958 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
959 append( sb, "Expression: ${splitindex}", 3 );
960 append( sb, "", 0 );
961
962 append( sb, "stylesheet (Default: java)", 2 );
963 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
964 append( sb, "Expression: ${stylesheet}", 3 );
965 append( sb, "", 0 );
966
967 append( sb, "stylesheetfile", 2 );
968 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
969 append( sb, "Expression: ${stylesheetfile}", 3 );
970 append( sb, "", 0 );
971
972 append( sb, "subpackages", 2 );
973 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
974 append( sb, "Expression: ${subpackages}", 3 );
975 append( sb, "", 0 );
976
977 append( sb, "taglet", 2 );
978 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
979 append( sb, "Expression: ${taglet}", 3 );
980 append( sb, "", 0 );
981
982 append( sb, "tagletArtifact", 2 );
983 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
984 append( sb, "Expression: ${tagletArtifact}", 3 );
985 append( sb, "", 0 );
986
987 append( sb, "tagletArtifacts", 2 );
988 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
989 append( sb, "Expression: ${tagletArtifacts}", 3 );
990 append( sb, "", 0 );
991
992 append( sb, "tagletpath", 2 );
993 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
994 append( sb, "Expression: ${tagletpath}", 3 );
995 append( sb, "", 0 );
996
997 append( sb, "taglets", 2 );
998 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
999 append( sb, "Expression: ${taglets}", 3 );
1000 append( sb, "", 0 );
1001
1002 append( sb, "tags", 2 );
1003 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
1004 append( sb, "Expression: ${tags}", 3 );
1005 append( sb, "", 0 );
1006
1007 append( sb, "top", 2 );
1008 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
1009 append( sb, "Expression: ${top}", 3 );
1010 append( sb, "", 0 );
1011
1012 append( sb, "use (Default: true)", 2 );
1013 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
1014 append( sb, "Expression: ${use}", 3 );
1015 append( sb, "", 0 );
1016
1017 append( sb, "useDefaultManifestFile (Default: false)", 2 );
1018 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
1019 append( sb, "", 0 );
1020
1021 append( sb, "useStandardDocletOptions (Default: true)", 2 );
1022 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
1023 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
1024 append( sb, "", 0 );
1025
1026 append( sb, "validateLinks (Default: false)", 2 );
1027 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
1028 append( sb, "Expression: ${validateLinks}", 3 );
1029 append( sb, "", 0 );
1030
1031 append( sb, "verbose (Default: false)", 2 );
1032 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
1033 append( sb, "Expression: ${verbose}", 3 );
1034 append( sb, "", 0 );
1035
1036 append( sb, "version (Default: true)", 2 );
1037 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
1038 append( sb, "Expression: ${version}", 3 );
1039 append( sb, "", 0 );
1040
1041 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
1042 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
1043 append( sb, "Expression: ${windowtitle}", 3 );
1044 append( sb, "", 0 );
1045 }
1046 }
1047
1048 if ( goal == null || goal.length() <= 0 || "fix".equals( goal ) )
1049 {
1050 append( sb, "javadoc:fix", 0 );
1051 append( sb, "Fix Javadoc documentation and tags for the Java code for the project. See Where Tags Can Be Used.", 1 );
1052 append( sb, "", 0 );
1053 if ( detail )
1054 {
1055 append( sb, "Available parameters:", 1 );
1056 append( sb, "", 0 );
1057
1058 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
1059 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
1060 append( sb, "Expression: ${comparisonVersion}", 3 );
1061 append( sb, "", 0 );
1062
1063 append( sb, "defaultAuthor", 2 );
1064 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
1065 append( sb, "Expression: ${defaultAuthor}", 3 );
1066 append( sb, "", 0 );
1067
1068 append( sb, "defaultSince (Default: ${project.version})", 2 );
1069 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
1070 append( sb, "Expression: ${defaultSince}", 3 );
1071 append( sb, "", 0 );
1072
1073 append( sb, "defaultVersion", 2 );
1074 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
1075 append( sb, "Expression: ${defaultVersion}", 3 );
1076 append( sb, "", 0 );
1077
1078 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1079 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
1080 append( sb, "Expression: ${encoding}", 3 );
1081 append( sb, "", 0 );
1082
1083 append( sb, "excludes", 2 );
1084 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
1085 append( sb, "Expression: ${excludes}", 3 );
1086 append( sb, "", 0 );
1087
1088 append( sb, "fixClassComment (Default: true)", 2 );
1089 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
1090 append( sb, "Expression: ${fixClassComment}", 3 );
1091 append( sb, "", 0 );
1092
1093 append( sb, "fixFieldComment (Default: true)", 2 );
1094 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
1095 append( sb, "Expression: ${fixFieldComment}", 3 );
1096 append( sb, "", 0 );
1097
1098 append( sb, "fixMethodComment (Default: true)", 2 );
1099 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
1100 append( sb, "Expression: ${fixMethodComment}", 3 );
1101 append( sb, "", 0 );
1102
1103 append( sb, "fixTags (Default: all)", 2 );
1104 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n", 3 );
1105 append( sb, "Expression: ${fixTags}", 3 );
1106 append( sb, "", 0 );
1107
1108 append( sb, "force", 2 );
1109 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
1110 append( sb, "Expression: ${force}", 3 );
1111 append( sb, "", 0 );
1112
1113 append( sb, "ignoreClirr (Default: false)", 2 );
1114 append( sb, "Flag to ignore or not Clirr.", 3 );
1115 append( sb, "Expression: ${ignoreClirr}", 3 );
1116 append( sb, "", 0 );
1117
1118 append( sb, "includes (Default: **/*.java)", 2 );
1119 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
1120 append( sb, "Expression: ${includes}", 3 );
1121 append( sb, "", 0 );
1122
1123 append( sb, "level (Default: protected)", 2 );
1124 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
1125 append( sb, "Expression: ${level}", 3 );
1126 append( sb, "", 0 );
1127
1128 append( sb, "localRepository", 2 );
1129 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
1130 append( sb, "Expression: ${localRepository}", 3 );
1131 append( sb, "", 0 );
1132
1133 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
1134 append( sb, "Output directory where Java classes will be rewritten.", 3 );
1135 append( sb, "Expression: ${outputDirectory}", 3 );
1136 append( sb, "", 0 );
1137 }
1138 }
1139
1140 if ( goal == null || goal.length() <= 0 || "help".equals( goal ) )
1141 {
1142 append( sb, "javadoc:help", 0 );
1143 append( sb, "Display help information on maven-javadoc-plugin.\nCall\n\u00a0\u00a0mvn\u00a0javadoc:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 );
1144 append( sb, "", 0 );
1145 if ( detail )
1146 {
1147 append( sb, "Available parameters:", 1 );
1148 append( sb, "", 0 );
1149
1150 append( sb, "detail (Default: false)", 2 );
1151 append( sb, "If true, display all settable properties for each goal.", 3 );
1152 append( sb, "Expression: ${detail}", 3 );
1153 append( sb, "", 0 );
1154
1155 append( sb, "goal", 2 );
1156 append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 );
1157 append( sb, "Expression: ${goal}", 3 );
1158 append( sb, "", 0 );
1159
1160 append( sb, "indentSize (Default: 2)", 2 );
1161 append( sb, "The number of spaces per indentation level, should be positive.", 3 );
1162 append( sb, "Expression: ${indentSize}", 3 );
1163 append( sb, "", 0 );
1164
1165 append( sb, "lineLength (Default: 80)", 2 );
1166 append( sb, "The maximum length of a display line, should be positive.", 3 );
1167 append( sb, "Expression: ${lineLength}", 3 );
1168 append( sb, "", 0 );
1169 }
1170 }
1171
1172 if ( goal == null || goal.length() <= 0 || "jar".equals( goal ) )
1173 {
1174 append( sb, "javadoc:jar", 0 );
1175 append( sb, "Bundles the Javadoc documentation for main Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
1176 append( sb, "", 0 );
1177 if ( detail )
1178 {
1179 append( sb, "Available parameters:", 1 );
1180 append( sb, "", 0 );
1181
1182 append( sb, "additionalJOption", 2 );
1183 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
1184 append( sb, "Expression: ${additionalJOption}", 3 );
1185 append( sb, "", 0 );
1186
1187 append( sb, "additionalparam", 2 );
1188 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
1189 append( sb, "Expression: ${additionalparam}", 3 );
1190 append( sb, "", 0 );
1191
1192 append( sb, "aggregate (Default: false)", 2 );
1193 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
1194 append( sb, "", 0 );
1195 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
1196 append( sb, "Expression: ${aggregate}", 3 );
1197 append( sb, "", 0 );
1198
1199 append( sb, "archive", 2 );
1200 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
1201 append( sb, "", 0 );
1202
1203 append( sb, "attach (Default: true)", 2 );
1204 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
1205 append( sb, "Expression: ${attach}", 3 );
1206 append( sb, "", 0 );
1207
1208 append( sb, "author (Default: true)", 2 );
1209 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
1210 append( sb, "Expression: ${author}", 3 );
1211 append( sb, "", 0 );
1212
1213 append( sb, "bootclasspath", 2 );
1214 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
1215 append( sb, "Expression: ${bootclasspath}", 3 );
1216 append( sb, "", 0 );
1217
1218 append( sb, "bootclasspathArtifacts", 2 );
1219 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
1220 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
1221 append( sb, "", 0 );
1222
1223 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
1224 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
1225 append( sb, "Expression: ${bottom}", 3 );
1226 append( sb, "", 0 );
1227
1228 append( sb, "breakiterator (Default: false)", 2 );
1229 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
1230 append( sb, "Expression: ${breakiterator}", 3 );
1231 append( sb, "", 0 );
1232
1233 append( sb, "charset", 2 );
1234 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
1235 append( sb, "Expression: ${charset}", 3 );
1236 append( sb, "", 0 );
1237
1238 append( sb, "debug (Default: false)", 2 );
1239 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
1240 append( sb, "Expression: ${debug}", 3 );
1241 append( sb, "", 0 );
1242
1243 append( sb, "dependencySourceExcludes", 2 );
1244 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
1245 append( sb, "", 0 );
1246
1247 append( sb, "dependencySourceIncludes", 2 );
1248 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
1249 append( sb, "", 0 );
1250
1251 append( sb, "destDir", 2 );
1252 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
1253 append( sb, "Expression: ${destDir}", 3 );
1254 append( sb, "", 0 );
1255
1256 append( sb, "detectJavaApiLink (Default: true)", 2 );
1257 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
1258 append( sb, "Expression: ${detectJavaApiLink}", 3 );
1259 append( sb, "", 0 );
1260
1261 append( sb, "detectLinks (Default: false)", 2 );
1262 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
1263 append( sb, "Expression: ${detectLinks}", 3 );
1264 append( sb, "", 0 );
1265
1266 append( sb, "detectOfflineLinks (Default: true)", 2 );
1267 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
1268 append( sb, "Expression: ${detectOfflineLinks}", 3 );
1269 append( sb, "", 0 );
1270
1271 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
1272 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
1273 append( sb, "Expression: ${docencoding}", 3 );
1274 append( sb, "", 0 );
1275
1276 append( sb, "docfilessubdirs (Default: false)", 2 );
1277 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
1278 append( sb, "Expression: ${docfilessubdirs}", 3 );
1279 append( sb, "", 0 );
1280
1281 append( sb, "doclet", 2 );
1282 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
1283 append( sb, "Expression: ${doclet}", 3 );
1284 append( sb, "", 0 );
1285
1286 append( sb, "docletArtifact", 2 );
1287 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
1288 append( sb, "Expression: ${docletArtifact}", 3 );
1289 append( sb, "", 0 );
1290
1291 append( sb, "docletArtifacts", 2 );
1292 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
1293 append( sb, "Expression: ${docletArtifacts}", 3 );
1294 append( sb, "", 0 );
1295
1296 append( sb, "docletPath", 2 );
1297 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
1298 append( sb, "Expression: ${docletPath}", 3 );
1299 append( sb, "", 0 );
1300
1301 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
1302 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
1303 append( sb, "Expression: ${doctitle}", 3 );
1304 append( sb, "", 0 );
1305
1306 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1307 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
1308 append( sb, "Expression: ${encoding}", 3 );
1309 append( sb, "", 0 );
1310
1311 append( sb, "excludedocfilessubdir", 2 );
1312 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
1313 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
1314 append( sb, "", 0 );
1315
1316 append( sb, "excludePackageNames", 2 );
1317 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
1318 append( sb, "Expression: ${excludePackageNames}", 3 );
1319 append( sb, "", 0 );
1320
1321 append( sb, "extdirs", 2 );
1322 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
1323 append( sb, "Expression: ${extdirs}", 3 );
1324 append( sb, "", 0 );
1325
1326 append( sb, "failOnError (Default: true)", 2 );
1327 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
1328 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
1329 append( sb, "", 0 );
1330
1331 append( sb, "finalName", 2 );
1332 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
1333 append( sb, "Expression: ${project.build.finalName}", 3 );
1334 append( sb, "", 0 );
1335
1336 append( sb, "footer", 2 );
1337 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
1338 append( sb, "Expression: ${footer}", 3 );
1339 append( sb, "", 0 );
1340
1341 append( sb, "groups", 2 );
1342 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
1343 append( sb, "Expression: ${groups}", 3 );
1344 append( sb, "", 0 );
1345
1346 append( sb, "header", 2 );
1347 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
1348 append( sb, "Expression: ${header}", 3 );
1349 append( sb, "", 0 );
1350
1351 append( sb, "helpfile", 2 );
1352 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
1353 append( sb, "Expression: ${helpfile}", 3 );
1354 append( sb, "", 0 );
1355
1356 append( sb, "includeDependencySources (Default: false)", 2 );
1357 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
1358 append( sb, "", 0 );
1359
1360 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
1361 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
1362 append( sb, "", 0 );
1363
1364 append( sb, "jarOutputDirectory", 2 );
1365 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
1366 append( sb, "Expression: ${project.build.directory}", 3 );
1367 append( sb, "", 0 );
1368
1369 append( sb, "javaApiLinks", 2 );
1370 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
1371 append( sb, "Expression: ${javaApiLinks}", 3 );
1372 append( sb, "", 0 );
1373
1374 append( sb, "javadocDirectory", 2 );
1375 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
1376 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
1377 append( sb, "", 0 );
1378
1379 append( sb, "javadocExecutable", 2 );
1380 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
1381 append( sb, "Expression: ${javadocExecutable}", 3 );
1382 append( sb, "", 0 );
1383
1384 append( sb, "javadocVersion", 2 );
1385 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
1386 append( sb, "Expression: ${javadocVersion}", 3 );
1387 append( sb, "", 0 );
1388
1389 append( sb, "keywords (Default: false)", 2 );
1390 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
1391 append( sb, "Expression: ${keywords}", 3 );
1392 append( sb, "", 0 );
1393
1394 append( sb, "links", 2 );
1395 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
1396 append( sb, "Expression: ${links}", 3 );
1397 append( sb, "", 0 );
1398
1399 append( sb, "linksource (Default: false)", 2 );
1400 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
1401 append( sb, "Expression: ${linksource}", 3 );
1402 append( sb, "", 0 );
1403
1404 append( sb, "locale", 2 );
1405 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
1406 append( sb, "Expression: ${locale}", 3 );
1407 append( sb, "", 0 );
1408
1409 append( sb, "localRepository", 2 );
1410 append( sb, "The local repository where the artifacts are located.", 3 );
1411 append( sb, "Expression: ${localRepository}", 3 );
1412 append( sb, "", 0 );
1413
1414 append( sb, "maxmemory", 2 );
1415 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
1416 append( sb, "Expression: ${maxmemory}", 3 );
1417 append( sb, "", 0 );
1418
1419 append( sb, "minmemory", 2 );
1420 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
1421 append( sb, "Expression: ${minmemory}", 3 );
1422 append( sb, "", 0 );
1423
1424 append( sb, "nocomment (Default: false)", 2 );
1425 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
1426 append( sb, "Expression: ${nocomment}", 3 );
1427 append( sb, "", 0 );
1428
1429 append( sb, "nodeprecated (Default: false)", 2 );
1430 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
1431 append( sb, "Expression: ${nodeprecated}", 3 );
1432 append( sb, "", 0 );
1433
1434 append( sb, "nodeprecatedlist (Default: false)", 2 );
1435 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
1436 append( sb, "Expression: ${nodeprecatedlist}", 3 );
1437 append( sb, "", 0 );
1438
1439 append( sb, "nohelp (Default: false)", 2 );
1440 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
1441 append( sb, "Expression: ${nohelp}", 3 );
1442 append( sb, "", 0 );
1443
1444 append( sb, "noindex (Default: false)", 2 );
1445 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
1446 append( sb, "Expression: ${noindex}", 3 );
1447 append( sb, "", 0 );
1448
1449 append( sb, "nonavbar (Default: false)", 2 );
1450 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
1451 append( sb, "Expression: ${nonavbar}", 3 );
1452 append( sb, "", 0 );
1453
1454 append( sb, "nooverview (Default: false)", 2 );
1455 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
1456 append( sb, "Expression: ${nooverview}", 3 );
1457 append( sb, "", 0 );
1458
1459 append( sb, "noqualifier", 2 );
1460 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
1461 append( sb, "Expression: ${noqualifier}", 3 );
1462 append( sb, "", 0 );
1463
1464 append( sb, "nosince (Default: false)", 2 );
1465 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
1466 append( sb, "Expression: ${nosince}", 3 );
1467 append( sb, "", 0 );
1468
1469 append( sb, "notimestamp (Default: false)", 2 );
1470 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
1471 append( sb, "Expression: ${notimestamp}", 3 );
1472 append( sb, "", 0 );
1473
1474 append( sb, "notree (Default: false)", 2 );
1475 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
1476 append( sb, "Expression: ${notree}", 3 );
1477 append( sb, "", 0 );
1478
1479 append( sb, "offlineLinks", 2 );
1480 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
1481 append( sb, "Expression: ${offlineLinks}", 3 );
1482 append( sb, "", 0 );
1483
1484 append( sb, "old (Default: false)", 2 );
1485 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
1486 append( sb, "Expression: ${old}", 3 );
1487 append( sb, "", 0 );
1488
1489 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
1490 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
1491 append( sb, "Required: Yes", 3 );
1492 append( sb, "Expression: ${destDir}", 3 );
1493 append( sb, "", 0 );
1494
1495 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
1496 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
1497 append( sb, "Expression: ${overview}", 3 );
1498 append( sb, "", 0 );
1499
1500 append( sb, "packagesheader", 2 );
1501 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
1502 append( sb, "Expression: ${packagesheader}", 3 );
1503 append( sb, "", 0 );
1504
1505 append( sb, "proxyHost", 2 );
1506 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
1507 append( sb, "", 0 );
1508 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
1509 append( sb, "Expression: ${proxyHost}", 3 );
1510 append( sb, "", 0 );
1511
1512 append( sb, "proxyPort", 2 );
1513 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
1514 append( sb, "", 0 );
1515 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
1516 append( sb, "Expression: ${proxyPort}", 3 );
1517 append( sb, "", 0 );
1518
1519 append( sb, "quiet (Default: false)", 2 );
1520 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
1521 append( sb, "Expression: ${quiet}", 3 );
1522 append( sb, "", 0 );
1523
1524 append( sb, "remoteRepositories", 2 );
1525 append( sb, "The remote repositories where artifacts are located.", 3 );
1526 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
1527 append( sb, "", 0 );
1528
1529 append( sb, "resourcesArtifacts", 2 );
1530 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
1531 append( sb, "Expression: ${resourcesArtifacts}", 3 );
1532 append( sb, "", 0 );
1533
1534 append( sb, "serialwarn (Default: false)", 2 );
1535 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
1536 append( sb, "Expression: ${serialwarn}", 3 );
1537 append( sb, "", 0 );
1538
1539 append( sb, "show (Default: protected)", 2 );
1540 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
1541 append( sb, "Expression: ${show}", 3 );
1542 append( sb, "", 0 );
1543
1544 append( sb, "skip (Default: false)", 2 );
1545 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
1546 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
1547 append( sb, "", 0 );
1548
1549 append( sb, "source", 2 );
1550 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
1551 append( sb, "Expression: ${source}", 3 );
1552 append( sb, "", 0 );
1553
1554 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
1555 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
1556 append( sb, "", 0 );
1557
1558 append( sb, "sourcepath", 2 );
1559 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
1560 append( sb, "Expression: ${sourcepath}", 3 );
1561 append( sb, "", 0 );
1562
1563 append( sb, "sourcetab", 2 );
1564 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
1565 append( sb, "Expression: ${sourcetab}", 3 );
1566 append( sb, "", 0 );
1567
1568 append( sb, "splitindex (Default: false)", 2 );
1569 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
1570 append( sb, "Expression: ${splitindex}", 3 );
1571 append( sb, "", 0 );
1572
1573 append( sb, "stylesheet (Default: java)", 2 );
1574 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
1575 append( sb, "Expression: ${stylesheet}", 3 );
1576 append( sb, "", 0 );
1577
1578 append( sb, "stylesheetfile", 2 );
1579 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
1580 append( sb, "Expression: ${stylesheetfile}", 3 );
1581 append( sb, "", 0 );
1582
1583 append( sb, "subpackages", 2 );
1584 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
1585 append( sb, "Expression: ${subpackages}", 3 );
1586 append( sb, "", 0 );
1587
1588 append( sb, "taglet", 2 );
1589 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
1590 append( sb, "Expression: ${taglet}", 3 );
1591 append( sb, "", 0 );
1592
1593 append( sb, "tagletArtifact", 2 );
1594 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
1595 append( sb, "Expression: ${tagletArtifact}", 3 );
1596 append( sb, "", 0 );
1597
1598 append( sb, "tagletArtifacts", 2 );
1599 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
1600 append( sb, "Expression: ${tagletArtifacts}", 3 );
1601 append( sb, "", 0 );
1602
1603 append( sb, "tagletpath", 2 );
1604 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
1605 append( sb, "Expression: ${tagletpath}", 3 );
1606 append( sb, "", 0 );
1607
1608 append( sb, "taglets", 2 );
1609 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
1610 append( sb, "Expression: ${taglets}", 3 );
1611 append( sb, "", 0 );
1612
1613 append( sb, "tags", 2 );
1614 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
1615 append( sb, "Expression: ${tags}", 3 );
1616 append( sb, "", 0 );
1617
1618 append( sb, "top", 2 );
1619 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
1620 append( sb, "Expression: ${top}", 3 );
1621 append( sb, "", 0 );
1622
1623 append( sb, "use (Default: true)", 2 );
1624 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
1625 append( sb, "Expression: ${use}", 3 );
1626 append( sb, "", 0 );
1627
1628 append( sb, "useDefaultManifestFile (Default: false)", 2 );
1629 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
1630 append( sb, "", 0 );
1631
1632 append( sb, "useStandardDocletOptions (Default: true)", 2 );
1633 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
1634 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
1635 append( sb, "", 0 );
1636
1637 append( sb, "validateLinks (Default: false)", 2 );
1638 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
1639 append( sb, "Expression: ${validateLinks}", 3 );
1640 append( sb, "", 0 );
1641
1642 append( sb, "verbose (Default: false)", 2 );
1643 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
1644 append( sb, "Expression: ${verbose}", 3 );
1645 append( sb, "", 0 );
1646
1647 append( sb, "version (Default: true)", 2 );
1648 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
1649 append( sb, "Expression: ${version}", 3 );
1650 append( sb, "", 0 );
1651
1652 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
1653 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
1654 append( sb, "Expression: ${windowtitle}", 3 );
1655 append( sb, "", 0 );
1656 }
1657 }
1658
1659 if ( goal == null || goal.length() <= 0 || "javadoc".equals( goal ) )
1660 {
1661 append( sb, "javadoc:javadoc", 0 );
1662 append( sb, "Generates documentation for the Java code in an NON aggregator project using the standard Javadoc Tool.", 1 );
1663 append( sb, "", 0 );
1664 if ( detail )
1665 {
1666 append( sb, "Available parameters:", 1 );
1667 append( sb, "", 0 );
1668
1669 append( sb, "additionalJOption", 2 );
1670 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
1671 append( sb, "Expression: ${additionalJOption}", 3 );
1672 append( sb, "", 0 );
1673
1674 append( sb, "additionalparam", 2 );
1675 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
1676 append( sb, "Expression: ${additionalparam}", 3 );
1677 append( sb, "", 0 );
1678
1679 append( sb, "aggregate (Default: false)", 2 );
1680 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
1681 append( sb, "", 0 );
1682 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
1683 append( sb, "Expression: ${aggregate}", 3 );
1684 append( sb, "", 0 );
1685
1686 append( sb, "author (Default: true)", 2 );
1687 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
1688 append( sb, "Expression: ${author}", 3 );
1689 append( sb, "", 0 );
1690
1691 append( sb, "bootclasspath", 2 );
1692 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
1693 append( sb, "Expression: ${bootclasspath}", 3 );
1694 append( sb, "", 0 );
1695
1696 append( sb, "bootclasspathArtifacts", 2 );
1697 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
1698 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
1699 append( sb, "", 0 );
1700
1701 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
1702 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
1703 append( sb, "Expression: ${bottom}", 3 );
1704 append( sb, "", 0 );
1705
1706 append( sb, "breakiterator (Default: false)", 2 );
1707 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
1708 append( sb, "Expression: ${breakiterator}", 3 );
1709 append( sb, "", 0 );
1710
1711 append( sb, "charset", 2 );
1712 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
1713 append( sb, "Expression: ${charset}", 3 );
1714 append( sb, "", 0 );
1715
1716 append( sb, "debug (Default: false)", 2 );
1717 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
1718 append( sb, "Expression: ${debug}", 3 );
1719 append( sb, "", 0 );
1720
1721 append( sb, "dependencySourceExcludes", 2 );
1722 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
1723 append( sb, "", 0 );
1724
1725 append( sb, "dependencySourceIncludes", 2 );
1726 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
1727 append( sb, "", 0 );
1728
1729 append( sb, "description", 2 );
1730 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
1731 append( sb, "Expression: ${description}", 3 );
1732 append( sb, "", 0 );
1733
1734 append( sb, "destDir (Default: apidocs)", 2 );
1735 append( sb, "The name of the destination directory.\n", 3 );
1736 append( sb, "Expression: ${destDir}", 3 );
1737 append( sb, "", 0 );
1738
1739 append( sb, "detectJavaApiLink (Default: true)", 2 );
1740 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
1741 append( sb, "Expression: ${detectJavaApiLink}", 3 );
1742 append( sb, "", 0 );
1743
1744 append( sb, "detectLinks (Default: false)", 2 );
1745 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
1746 append( sb, "Expression: ${detectLinks}", 3 );
1747 append( sb, "", 0 );
1748
1749 append( sb, "detectOfflineLinks (Default: true)", 2 );
1750 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
1751 append( sb, "Expression: ${detectOfflineLinks}", 3 );
1752 append( sb, "", 0 );
1753
1754 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
1755 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
1756 append( sb, "Expression: ${docencoding}", 3 );
1757 append( sb, "", 0 );
1758
1759 append( sb, "docfilessubdirs (Default: false)", 2 );
1760 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
1761 append( sb, "Expression: ${docfilessubdirs}", 3 );
1762 append( sb, "", 0 );
1763
1764 append( sb, "doclet", 2 );
1765 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
1766 append( sb, "Expression: ${doclet}", 3 );
1767 append( sb, "", 0 );
1768
1769 append( sb, "docletArtifact", 2 );
1770 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
1771 append( sb, "Expression: ${docletArtifact}", 3 );
1772 append( sb, "", 0 );
1773
1774 append( sb, "docletArtifacts", 2 );
1775 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
1776 append( sb, "Expression: ${docletArtifacts}", 3 );
1777 append( sb, "", 0 );
1778
1779 append( sb, "docletPath", 2 );
1780 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
1781 append( sb, "Expression: ${docletPath}", 3 );
1782 append( sb, "", 0 );
1783
1784 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
1785 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
1786 append( sb, "Expression: ${doctitle}", 3 );
1787 append( sb, "", 0 );
1788
1789 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
1790 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
1791 append( sb, "Expression: ${encoding}", 3 );
1792 append( sb, "", 0 );
1793
1794 append( sb, "excludedocfilessubdir", 2 );
1795 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
1796 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
1797 append( sb, "", 0 );
1798
1799 append( sb, "excludePackageNames", 2 );
1800 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
1801 append( sb, "Expression: ${excludePackageNames}", 3 );
1802 append( sb, "", 0 );
1803
1804 append( sb, "extdirs", 2 );
1805 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
1806 append( sb, "Expression: ${extdirs}", 3 );
1807 append( sb, "", 0 );
1808
1809 append( sb, "failOnError (Default: true)", 2 );
1810 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
1811 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
1812 append( sb, "", 0 );
1813
1814 append( sb, "footer", 2 );
1815 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
1816 append( sb, "Expression: ${footer}", 3 );
1817 append( sb, "", 0 );
1818
1819 append( sb, "groups", 2 );
1820 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
1821 append( sb, "Expression: ${groups}", 3 );
1822 append( sb, "", 0 );
1823
1824 append( sb, "header", 2 );
1825 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
1826 append( sb, "Expression: ${header}", 3 );
1827 append( sb, "", 0 );
1828
1829 append( sb, "helpfile", 2 );
1830 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
1831 append( sb, "Expression: ${helpfile}", 3 );
1832 append( sb, "", 0 );
1833
1834 append( sb, "includeDependencySources (Default: false)", 2 );
1835 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
1836 append( sb, "", 0 );
1837
1838 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
1839 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
1840 append( sb, "", 0 );
1841
1842 append( sb, "javaApiLinks", 2 );
1843 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
1844 append( sb, "Expression: ${javaApiLinks}", 3 );
1845 append( sb, "", 0 );
1846
1847 append( sb, "javadocDirectory", 2 );
1848 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
1849 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
1850 append( sb, "", 0 );
1851
1852 append( sb, "javadocExecutable", 2 );
1853 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
1854 append( sb, "Expression: ${javadocExecutable}", 3 );
1855 append( sb, "", 0 );
1856
1857 append( sb, "javadocVersion", 2 );
1858 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
1859 append( sb, "Expression: ${javadocVersion}", 3 );
1860 append( sb, "", 0 );
1861
1862 append( sb, "keywords (Default: false)", 2 );
1863 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
1864 append( sb, "Expression: ${keywords}", 3 );
1865 append( sb, "", 0 );
1866
1867 append( sb, "links", 2 );
1868 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
1869 append( sb, "Expression: ${links}", 3 );
1870 append( sb, "", 0 );
1871
1872 append( sb, "linksource (Default: false)", 2 );
1873 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
1874 append( sb, "Expression: ${linksource}", 3 );
1875 append( sb, "", 0 );
1876
1877 append( sb, "locale", 2 );
1878 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
1879 append( sb, "Expression: ${locale}", 3 );
1880 append( sb, "", 0 );
1881
1882 append( sb, "localRepository", 2 );
1883 append( sb, "The local repository where the artifacts are located.", 3 );
1884 append( sb, "Expression: ${localRepository}", 3 );
1885 append( sb, "", 0 );
1886
1887 append( sb, "maxmemory", 2 );
1888 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
1889 append( sb, "Expression: ${maxmemory}", 3 );
1890 append( sb, "", 0 );
1891
1892 append( sb, "minmemory", 2 );
1893 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
1894 append( sb, "Expression: ${minmemory}", 3 );
1895 append( sb, "", 0 );
1896
1897 append( sb, "name", 2 );
1898 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
1899 append( sb, "Expression: ${name}", 3 );
1900 append( sb, "", 0 );
1901
1902 append( sb, "nocomment (Default: false)", 2 );
1903 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
1904 append( sb, "Expression: ${nocomment}", 3 );
1905 append( sb, "", 0 );
1906
1907 append( sb, "nodeprecated (Default: false)", 2 );
1908 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
1909 append( sb, "Expression: ${nodeprecated}", 3 );
1910 append( sb, "", 0 );
1911
1912 append( sb, "nodeprecatedlist (Default: false)", 2 );
1913 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
1914 append( sb, "Expression: ${nodeprecatedlist}", 3 );
1915 append( sb, "", 0 );
1916
1917 append( sb, "nohelp (Default: false)", 2 );
1918 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
1919 append( sb, "Expression: ${nohelp}", 3 );
1920 append( sb, "", 0 );
1921
1922 append( sb, "noindex (Default: false)", 2 );
1923 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
1924 append( sb, "Expression: ${noindex}", 3 );
1925 append( sb, "", 0 );
1926
1927 append( sb, "nonavbar (Default: false)", 2 );
1928 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
1929 append( sb, "Expression: ${nonavbar}", 3 );
1930 append( sb, "", 0 );
1931
1932 append( sb, "nooverview (Default: false)", 2 );
1933 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
1934 append( sb, "Expression: ${nooverview}", 3 );
1935 append( sb, "", 0 );
1936
1937 append( sb, "noqualifier", 2 );
1938 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
1939 append( sb, "Expression: ${noqualifier}", 3 );
1940 append( sb, "", 0 );
1941
1942 append( sb, "nosince (Default: false)", 2 );
1943 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
1944 append( sb, "Expression: ${nosince}", 3 );
1945 append( sb, "", 0 );
1946
1947 append( sb, "notimestamp (Default: false)", 2 );
1948 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
1949 append( sb, "Expression: ${notimestamp}", 3 );
1950 append( sb, "", 0 );
1951
1952 append( sb, "notree (Default: false)", 2 );
1953 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
1954 append( sb, "Expression: ${notree}", 3 );
1955 append( sb, "", 0 );
1956
1957 append( sb, "offlineLinks", 2 );
1958 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
1959 append( sb, "Expression: ${offlineLinks}", 3 );
1960 append( sb, "", 0 );
1961
1962 append( sb, "old (Default: false)", 2 );
1963 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
1964 append( sb, "Expression: ${old}", 3 );
1965 append( sb, "", 0 );
1966
1967 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
1968 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
1969 append( sb, "Required: Yes", 3 );
1970 append( sb, "Expression: ${destDir}", 3 );
1971 append( sb, "", 0 );
1972
1973 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
1974 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
1975 append( sb, "Expression: ${overview}", 3 );
1976 append( sb, "", 0 );
1977
1978 append( sb, "packagesheader", 2 );
1979 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
1980 append( sb, "Expression: ${packagesheader}", 3 );
1981 append( sb, "", 0 );
1982
1983 append( sb, "proxyHost", 2 );
1984 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
1985 append( sb, "", 0 );
1986 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
1987 append( sb, "Expression: ${proxyHost}", 3 );
1988 append( sb, "", 0 );
1989
1990 append( sb, "proxyPort", 2 );
1991 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
1992 append( sb, "", 0 );
1993 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
1994 append( sb, "Expression: ${proxyPort}", 3 );
1995 append( sb, "", 0 );
1996
1997 append( sb, "quiet (Default: false)", 2 );
1998 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
1999 append( sb, "Expression: ${quiet}", 3 );
2000 append( sb, "", 0 );
2001
2002 append( sb, "remoteRepositories", 2 );
2003 append( sb, "The remote repositories where artifacts are located.", 3 );
2004 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2005 append( sb, "", 0 );
2006
2007 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/apidocs)", 2 );
2008 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.", 3 );
2009 append( sb, "Required: Yes", 3 );
2010 append( sb, "Expression: ${reportOutputDirectory}", 3 );
2011 append( sb, "", 0 );
2012
2013 append( sb, "resourcesArtifacts", 2 );
2014 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
2015 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2016 append( sb, "", 0 );
2017
2018 append( sb, "serialwarn (Default: false)", 2 );
2019 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2020 append( sb, "Expression: ${serialwarn}", 3 );
2021 append( sb, "", 0 );
2022
2023 append( sb, "show (Default: protected)", 2 );
2024 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
2025 append( sb, "Expression: ${show}", 3 );
2026 append( sb, "", 0 );
2027
2028 append( sb, "skip (Default: false)", 2 );
2029 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2030 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2031 append( sb, "", 0 );
2032
2033 append( sb, "source", 2 );
2034 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
2035 append( sb, "Expression: ${source}", 3 );
2036 append( sb, "", 0 );
2037
2038 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
2039 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
2040 append( sb, "", 0 );
2041
2042 append( sb, "sourcepath", 2 );
2043 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
2044 append( sb, "Expression: ${sourcepath}", 3 );
2045 append( sb, "", 0 );
2046
2047 append( sb, "sourcetab", 2 );
2048 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
2049 append( sb, "Expression: ${sourcetab}", 3 );
2050 append( sb, "", 0 );
2051
2052 append( sb, "splitindex (Default: false)", 2 );
2053 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
2054 append( sb, "Expression: ${splitindex}", 3 );
2055 append( sb, "", 0 );
2056
2057 append( sb, "stylesheet (Default: java)", 2 );
2058 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
2059 append( sb, "Expression: ${stylesheet}", 3 );
2060 append( sb, "", 0 );
2061
2062 append( sb, "stylesheetfile", 2 );
2063 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
2064 append( sb, "Expression: ${stylesheetfile}", 3 );
2065 append( sb, "", 0 );
2066
2067 append( sb, "subpackages", 2 );
2068 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
2069 append( sb, "Expression: ${subpackages}", 3 );
2070 append( sb, "", 0 );
2071
2072 append( sb, "taglet", 2 );
2073 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
2074 append( sb, "Expression: ${taglet}", 3 );
2075 append( sb, "", 0 );
2076
2077 append( sb, "tagletArtifact", 2 );
2078 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
2079 append( sb, "Expression: ${tagletArtifact}", 3 );
2080 append( sb, "", 0 );
2081
2082 append( sb, "tagletArtifacts", 2 );
2083 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
2084 append( sb, "Expression: ${tagletArtifacts}", 3 );
2085 append( sb, "", 0 );
2086
2087 append( sb, "tagletpath", 2 );
2088 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
2089 append( sb, "Expression: ${tagletpath}", 3 );
2090 append( sb, "", 0 );
2091
2092 append( sb, "taglets", 2 );
2093 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
2094 append( sb, "Expression: ${taglets}", 3 );
2095 append( sb, "", 0 );
2096
2097 append( sb, "tags", 2 );
2098 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
2099 append( sb, "Expression: ${tags}", 3 );
2100 append( sb, "", 0 );
2101
2102 append( sb, "top", 2 );
2103 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
2104 append( sb, "Expression: ${top}", 3 );
2105 append( sb, "", 0 );
2106
2107 append( sb, "use (Default: true)", 2 );
2108 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
2109 append( sb, "Expression: ${use}", 3 );
2110 append( sb, "", 0 );
2111
2112 append( sb, "useStandardDocletOptions (Default: true)", 2 );
2113 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
2114 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
2115 append( sb, "", 0 );
2116
2117 append( sb, "validateLinks (Default: false)", 2 );
2118 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
2119 append( sb, "Expression: ${validateLinks}", 3 );
2120 append( sb, "", 0 );
2121
2122 append( sb, "verbose (Default: false)", 2 );
2123 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
2124 append( sb, "Expression: ${verbose}", 3 );
2125 append( sb, "", 0 );
2126
2127 append( sb, "version (Default: true)", 2 );
2128 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
2129 append( sb, "Expression: ${version}", 3 );
2130 append( sb, "", 0 );
2131
2132 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
2133 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
2134 append( sb, "Expression: ${windowtitle}", 3 );
2135 append( sb, "", 0 );
2136 }
2137 }
2138
2139 if ( goal == null || goal.length() <= 0 || "resource-bundle".equals( goal ) )
2140 {
2141 append( sb, "javadoc:resource-bundle", 0 );
2142 append( sb, "Bundle AbstractJavadocMojo.javadocDirectory, along with javadoc configuration options such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
2143 append( sb, "", 0 );
2144 if ( detail )
2145 {
2146 append( sb, "Available parameters:", 1 );
2147 append( sb, "", 0 );
2148
2149 append( sb, "additionalJOption", 2 );
2150 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
2151 append( sb, "Expression: ${additionalJOption}", 3 );
2152 append( sb, "", 0 );
2153
2154 append( sb, "additionalparam", 2 );
2155 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
2156 append( sb, "Expression: ${additionalparam}", 3 );
2157 append( sb, "", 0 );
2158
2159 append( sb, "aggregate (Default: false)", 2 );
2160 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
2161 append( sb, "", 0 );
2162 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
2163 append( sb, "Expression: ${aggregate}", 3 );
2164 append( sb, "", 0 );
2165
2166 append( sb, "author (Default: true)", 2 );
2167 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
2168 append( sb, "Expression: ${author}", 3 );
2169 append( sb, "", 0 );
2170
2171 append( sb, "bootclasspath", 2 );
2172 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
2173 append( sb, "Expression: ${bootclasspath}", 3 );
2174 append( sb, "", 0 );
2175
2176 append( sb, "bootclasspathArtifacts", 2 );
2177 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
2178 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
2179 append( sb, "", 0 );
2180
2181 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
2182 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
2183 append( sb, "Expression: ${bottom}", 3 );
2184 append( sb, "", 0 );
2185
2186 append( sb, "breakiterator (Default: false)", 2 );
2187 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
2188 append( sb, "Expression: ${breakiterator}", 3 );
2189 append( sb, "", 0 );
2190
2191 append( sb, "charset", 2 );
2192 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
2193 append( sb, "Expression: ${charset}", 3 );
2194 append( sb, "", 0 );
2195
2196 append( sb, "debug (Default: false)", 2 );
2197 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
2198 append( sb, "Expression: ${debug}", 3 );
2199 append( sb, "", 0 );
2200
2201 append( sb, "dependencySourceExcludes", 2 );
2202 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
2203 append( sb, "", 0 );
2204
2205 append( sb, "dependencySourceIncludes", 2 );
2206 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
2207 append( sb, "", 0 );
2208
2209 append( sb, "detectJavaApiLink (Default: true)", 2 );
2210 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
2211 append( sb, "Expression: ${detectJavaApiLink}", 3 );
2212 append( sb, "", 0 );
2213
2214 append( sb, "detectLinks (Default: false)", 2 );
2215 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
2216 append( sb, "Expression: ${detectLinks}", 3 );
2217 append( sb, "", 0 );
2218
2219 append( sb, "detectOfflineLinks (Default: true)", 2 );
2220 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
2221 append( sb, "Expression: ${detectOfflineLinks}", 3 );
2222 append( sb, "", 0 );
2223
2224 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
2225 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
2226 append( sb, "Expression: ${docencoding}", 3 );
2227 append( sb, "", 0 );
2228
2229 append( sb, "docfilessubdirs (Default: false)", 2 );
2230 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
2231 append( sb, "Expression: ${docfilessubdirs}", 3 );
2232 append( sb, "", 0 );
2233
2234 append( sb, "doclet", 2 );
2235 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
2236 append( sb, "Expression: ${doclet}", 3 );
2237 append( sb, "", 0 );
2238
2239 append( sb, "docletArtifact", 2 );
2240 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
2241 append( sb, "Expression: ${docletArtifact}", 3 );
2242 append( sb, "", 0 );
2243
2244 append( sb, "docletArtifacts", 2 );
2245 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
2246 append( sb, "Expression: ${docletArtifacts}", 3 );
2247 append( sb, "", 0 );
2248
2249 append( sb, "docletPath", 2 );
2250 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
2251 append( sb, "Expression: ${docletPath}", 3 );
2252 append( sb, "", 0 );
2253
2254 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
2255 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
2256 append( sb, "Expression: ${doctitle}", 3 );
2257 append( sb, "", 0 );
2258
2259 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
2260 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
2261 append( sb, "Expression: ${encoding}", 3 );
2262 append( sb, "", 0 );
2263
2264 append( sb, "excludedocfilessubdir", 2 );
2265 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
2266 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
2267 append( sb, "", 0 );
2268
2269 append( sb, "excludePackageNames", 2 );
2270 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
2271 append( sb, "Expression: ${excludePackageNames}", 3 );
2272 append( sb, "", 0 );
2273
2274 append( sb, "extdirs", 2 );
2275 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
2276 append( sb, "Expression: ${extdirs}", 3 );
2277 append( sb, "", 0 );
2278
2279 append( sb, "failOnError (Default: true)", 2 );
2280 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
2281 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
2282 append( sb, "", 0 );
2283
2284 append( sb, "footer", 2 );
2285 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
2286 append( sb, "Expression: ${footer}", 3 );
2287 append( sb, "", 0 );
2288
2289 append( sb, "groups", 2 );
2290 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
2291 append( sb, "Expression: ${groups}", 3 );
2292 append( sb, "", 0 );
2293
2294 append( sb, "header", 2 );
2295 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
2296 append( sb, "Expression: ${header}", 3 );
2297 append( sb, "", 0 );
2298
2299 append( sb, "helpfile", 2 );
2300 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
2301 append( sb, "Expression: ${helpfile}", 3 );
2302 append( sb, "", 0 );
2303
2304 append( sb, "includeDependencySources (Default: false)", 2 );
2305 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
2306 append( sb, "", 0 );
2307
2308 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
2309 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
2310 append( sb, "", 0 );
2311
2312 append( sb, "javaApiLinks", 2 );
2313 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
2314 append( sb, "Expression: ${javaApiLinks}", 3 );
2315 append( sb, "", 0 );
2316
2317 append( sb, "javadocDirectory", 2 );
2318 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
2319 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
2320 append( sb, "", 0 );
2321
2322 append( sb, "javadocExecutable", 2 );
2323 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
2324 append( sb, "Expression: ${javadocExecutable}", 3 );
2325 append( sb, "", 0 );
2326
2327 append( sb, "javadocVersion", 2 );
2328 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
2329 append( sb, "Expression: ${javadocVersion}", 3 );
2330 append( sb, "", 0 );
2331
2332 append( sb, "keywords (Default: false)", 2 );
2333 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
2334 append( sb, "Expression: ${keywords}", 3 );
2335 append( sb, "", 0 );
2336
2337 append( sb, "links", 2 );
2338 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
2339 append( sb, "Expression: ${links}", 3 );
2340 append( sb, "", 0 );
2341
2342 append( sb, "linksource (Default: false)", 2 );
2343 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
2344 append( sb, "Expression: ${linksource}", 3 );
2345 append( sb, "", 0 );
2346
2347 append( sb, "locale", 2 );
2348 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
2349 append( sb, "Expression: ${locale}", 3 );
2350 append( sb, "", 0 );
2351
2352 append( sb, "localRepository", 2 );
2353 append( sb, "The local repository where the artifacts are located.", 3 );
2354 append( sb, "Expression: ${localRepository}", 3 );
2355 append( sb, "", 0 );
2356
2357 append( sb, "maxmemory", 2 );
2358 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
2359 append( sb, "Expression: ${maxmemory}", 3 );
2360 append( sb, "", 0 );
2361
2362 append( sb, "minmemory", 2 );
2363 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
2364 append( sb, "Expression: ${minmemory}", 3 );
2365 append( sb, "", 0 );
2366
2367 append( sb, "nocomment (Default: false)", 2 );
2368 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
2369 append( sb, "Expression: ${nocomment}", 3 );
2370 append( sb, "", 0 );
2371
2372 append( sb, "nodeprecated (Default: false)", 2 );
2373 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
2374 append( sb, "Expression: ${nodeprecated}", 3 );
2375 append( sb, "", 0 );
2376
2377 append( sb, "nodeprecatedlist (Default: false)", 2 );
2378 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
2379 append( sb, "Expression: ${nodeprecatedlist}", 3 );
2380 append( sb, "", 0 );
2381
2382 append( sb, "nohelp (Default: false)", 2 );
2383 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
2384 append( sb, "Expression: ${nohelp}", 3 );
2385 append( sb, "", 0 );
2386
2387 append( sb, "noindex (Default: false)", 2 );
2388 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
2389 append( sb, "Expression: ${noindex}", 3 );
2390 append( sb, "", 0 );
2391
2392 append( sb, "nonavbar (Default: false)", 2 );
2393 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
2394 append( sb, "Expression: ${nonavbar}", 3 );
2395 append( sb, "", 0 );
2396
2397 append( sb, "nooverview (Default: false)", 2 );
2398 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
2399 append( sb, "Expression: ${nooverview}", 3 );
2400 append( sb, "", 0 );
2401
2402 append( sb, "noqualifier", 2 );
2403 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
2404 append( sb, "Expression: ${noqualifier}", 3 );
2405 append( sb, "", 0 );
2406
2407 append( sb, "nosince (Default: false)", 2 );
2408 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
2409 append( sb, "Expression: ${nosince}", 3 );
2410 append( sb, "", 0 );
2411
2412 append( sb, "notimestamp (Default: false)", 2 );
2413 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
2414 append( sb, "Expression: ${notimestamp}", 3 );
2415 append( sb, "", 0 );
2416
2417 append( sb, "notree (Default: false)", 2 );
2418 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
2419 append( sb, "Expression: ${notree}", 3 );
2420 append( sb, "", 0 );
2421
2422 append( sb, "offlineLinks", 2 );
2423 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
2424 append( sb, "Expression: ${offlineLinks}", 3 );
2425 append( sb, "", 0 );
2426
2427 append( sb, "old (Default: false)", 2 );
2428 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
2429 append( sb, "Expression: ${old}", 3 );
2430 append( sb, "", 0 );
2431
2432 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
2433 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
2434 append( sb, "Required: Yes", 3 );
2435 append( sb, "Expression: ${destDir}", 3 );
2436 append( sb, "", 0 );
2437
2438 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
2439 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
2440 append( sb, "Expression: ${overview}", 3 );
2441 append( sb, "", 0 );
2442
2443 append( sb, "packagesheader", 2 );
2444 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
2445 append( sb, "Expression: ${packagesheader}", 3 );
2446 append( sb, "", 0 );
2447
2448 append( sb, "proxyHost", 2 );
2449 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
2450 append( sb, "", 0 );
2451 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
2452 append( sb, "Expression: ${proxyHost}", 3 );
2453 append( sb, "", 0 );
2454
2455 append( sb, "proxyPort", 2 );
2456 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
2457 append( sb, "", 0 );
2458 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
2459 append( sb, "Expression: ${proxyPort}", 3 );
2460 append( sb, "", 0 );
2461
2462 append( sb, "quiet (Default: false)", 2 );
2463 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
2464 append( sb, "Expression: ${quiet}", 3 );
2465 append( sb, "", 0 );
2466
2467 append( sb, "remoteRepositories", 2 );
2468 append( sb, "The remote repositories where artifacts are located.", 3 );
2469 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2470 append( sb, "", 0 );
2471
2472 append( sb, "resourcesArtifacts", 2 );
2473 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
2474 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2475 append( sb, "", 0 );
2476
2477 append( sb, "serialwarn (Default: false)", 2 );
2478 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2479 append( sb, "Expression: ${serialwarn}", 3 );
2480 append( sb, "", 0 );
2481
2482 append( sb, "show (Default: protected)", 2 );
2483 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
2484 append( sb, "Expression: ${show}", 3 );
2485 append( sb, "", 0 );
2486
2487 append( sb, "skip (Default: false)", 2 );
2488 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2489 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2490 append( sb, "", 0 );
2491
2492 append( sb, "source", 2 );
2493 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
2494 append( sb, "Expression: ${source}", 3 );
2495 append( sb, "", 0 );
2496
2497 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
2498 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
2499 append( sb, "", 0 );
2500
2501 append( sb, "sourcepath", 2 );
2502 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
2503 append( sb, "Expression: ${sourcepath}", 3 );
2504 append( sb, "", 0 );
2505
2506 append( sb, "sourcetab", 2 );
2507 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
2508 append( sb, "Expression: ${sourcetab}", 3 );
2509 append( sb, "", 0 );
2510
2511 append( sb, "splitindex (Default: false)", 2 );
2512 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
2513 append( sb, "Expression: ${splitindex}", 3 );
2514 append( sb, "", 0 );
2515
2516 append( sb, "stylesheet (Default: java)", 2 );
2517 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
2518 append( sb, "Expression: ${stylesheet}", 3 );
2519 append( sb, "", 0 );
2520
2521 append( sb, "stylesheetfile", 2 );
2522 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
2523 append( sb, "Expression: ${stylesheetfile}", 3 );
2524 append( sb, "", 0 );
2525
2526 append( sb, "subpackages", 2 );
2527 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
2528 append( sb, "Expression: ${subpackages}", 3 );
2529 append( sb, "", 0 );
2530
2531 append( sb, "taglet", 2 );
2532 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
2533 append( sb, "Expression: ${taglet}", 3 );
2534 append( sb, "", 0 );
2535
2536 append( sb, "tagletArtifact", 2 );
2537 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
2538 append( sb, "Expression: ${tagletArtifact}", 3 );
2539 append( sb, "", 0 );
2540
2541 append( sb, "tagletArtifacts", 2 );
2542 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
2543 append( sb, "Expression: ${tagletArtifacts}", 3 );
2544 append( sb, "", 0 );
2545
2546 append( sb, "tagletpath", 2 );
2547 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
2548 append( sb, "Expression: ${tagletpath}", 3 );
2549 append( sb, "", 0 );
2550
2551 append( sb, "taglets", 2 );
2552 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
2553 append( sb, "Expression: ${taglets}", 3 );
2554 append( sb, "", 0 );
2555
2556 append( sb, "tags", 2 );
2557 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
2558 append( sb, "Expression: ${tags}", 3 );
2559 append( sb, "", 0 );
2560
2561 append( sb, "top", 2 );
2562 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
2563 append( sb, "Expression: ${top}", 3 );
2564 append( sb, "", 0 );
2565
2566 append( sb, "use (Default: true)", 2 );
2567 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
2568 append( sb, "Expression: ${use}", 3 );
2569 append( sb, "", 0 );
2570
2571 append( sb, "useStandardDocletOptions (Default: true)", 2 );
2572 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
2573 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
2574 append( sb, "", 0 );
2575
2576 append( sb, "validateLinks (Default: false)", 2 );
2577 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
2578 append( sb, "Expression: ${validateLinks}", 3 );
2579 append( sb, "", 0 );
2580
2581 append( sb, "verbose (Default: false)", 2 );
2582 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
2583 append( sb, "Expression: ${verbose}", 3 );
2584 append( sb, "", 0 );
2585
2586 append( sb, "version (Default: true)", 2 );
2587 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
2588 append( sb, "Expression: ${version}", 3 );
2589 append( sb, "", 0 );
2590
2591 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
2592 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
2593 append( sb, "Expression: ${windowtitle}", 3 );
2594 append( sb, "", 0 );
2595 }
2596 }
2597
2598 if ( goal == null || goal.length() <= 0 || "test-aggregate".equals( goal ) )
2599 {
2600 append( sb, "javadoc:test-aggregate", 0 );
2601 append( sb, "Generates documentation for the Java Test code in an aggregator project using the standard Javadoc Tool.", 1 );
2602 append( sb, "", 0 );
2603 if ( detail )
2604 {
2605 append( sb, "Available parameters:", 1 );
2606 append( sb, "", 0 );
2607
2608 append( sb, "additionalJOption", 2 );
2609 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
2610 append( sb, "Expression: ${additionalJOption}", 3 );
2611 append( sb, "", 0 );
2612
2613 append( sb, "additionalparam", 2 );
2614 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
2615 append( sb, "Expression: ${additionalparam}", 3 );
2616 append( sb, "", 0 );
2617
2618 append( sb, "aggregate (Default: false)", 2 );
2619 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
2620 append( sb, "", 0 );
2621 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
2622 append( sb, "Expression: ${aggregate}", 3 );
2623 append( sb, "", 0 );
2624
2625 append( sb, "author (Default: true)", 2 );
2626 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
2627 append( sb, "Expression: ${author}", 3 );
2628 append( sb, "", 0 );
2629
2630 append( sb, "bootclasspath", 2 );
2631 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
2632 append( sb, "Expression: ${bootclasspath}", 3 );
2633 append( sb, "", 0 );
2634
2635 append( sb, "bootclasspathArtifacts", 2 );
2636 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
2637 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
2638 append( sb, "", 0 );
2639
2640 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
2641 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
2642 append( sb, "Expression: ${bottom}", 3 );
2643 append( sb, "", 0 );
2644
2645 append( sb, "breakiterator (Default: false)", 2 );
2646 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
2647 append( sb, "Expression: ${breakiterator}", 3 );
2648 append( sb, "", 0 );
2649
2650 append( sb, "charset", 2 );
2651 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
2652 append( sb, "Expression: ${charset}", 3 );
2653 append( sb, "", 0 );
2654
2655 append( sb, "debug (Default: false)", 2 );
2656 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
2657 append( sb, "Expression: ${debug}", 3 );
2658 append( sb, "", 0 );
2659
2660 append( sb, "dependencySourceExcludes", 2 );
2661 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
2662 append( sb, "", 0 );
2663
2664 append( sb, "dependencySourceIncludes", 2 );
2665 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
2666 append( sb, "", 0 );
2667
2668 append( sb, "description", 2 );
2669 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
2670 append( sb, "Expression: ${description}", 3 );
2671 append( sb, "", 0 );
2672
2673 append( sb, "destDir (Default: testapidocs)", 2 );
2674 append( sb, "The name of the destination directory.\n", 3 );
2675 append( sb, "Expression: ${destDir}", 3 );
2676 append( sb, "", 0 );
2677
2678 append( sb, "detectJavaApiLink (Default: true)", 2 );
2679 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
2680 append( sb, "Expression: ${detectJavaApiLink}", 3 );
2681 append( sb, "", 0 );
2682
2683 append( sb, "detectLinks (Default: false)", 2 );
2684 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
2685 append( sb, "Expression: ${detectLinks}", 3 );
2686 append( sb, "", 0 );
2687
2688 append( sb, "detectOfflineLinks (Default: true)", 2 );
2689 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
2690 append( sb, "Expression: ${detectOfflineLinks}", 3 );
2691 append( sb, "", 0 );
2692
2693 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
2694 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
2695 append( sb, "Expression: ${docencoding}", 3 );
2696 append( sb, "", 0 );
2697
2698 append( sb, "docfilessubdirs (Default: false)", 2 );
2699 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
2700 append( sb, "Expression: ${docfilessubdirs}", 3 );
2701 append( sb, "", 0 );
2702
2703 append( sb, "doclet", 2 );
2704 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
2705 append( sb, "Expression: ${doclet}", 3 );
2706 append( sb, "", 0 );
2707
2708 append( sb, "docletArtifact", 2 );
2709 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
2710 append( sb, "Expression: ${docletArtifact}", 3 );
2711 append( sb, "", 0 );
2712
2713 append( sb, "docletArtifacts", 2 );
2714 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
2715 append( sb, "Expression: ${docletArtifacts}", 3 );
2716 append( sb, "", 0 );
2717
2718 append( sb, "docletPath", 2 );
2719 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
2720 append( sb, "Expression: ${docletPath}", 3 );
2721 append( sb, "", 0 );
2722
2723 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
2724 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
2725 append( sb, "Expression: ${doctitle}", 3 );
2726 append( sb, "", 0 );
2727
2728 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
2729 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
2730 append( sb, "Expression: ${encoding}", 3 );
2731 append( sb, "", 0 );
2732
2733 append( sb, "excludedocfilessubdir", 2 );
2734 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
2735 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
2736 append( sb, "", 0 );
2737
2738 append( sb, "excludePackageNames", 2 );
2739 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
2740 append( sb, "Expression: ${excludePackageNames}", 3 );
2741 append( sb, "", 0 );
2742
2743 append( sb, "extdirs", 2 );
2744 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
2745 append( sb, "Expression: ${extdirs}", 3 );
2746 append( sb, "", 0 );
2747
2748 append( sb, "failOnError (Default: true)", 2 );
2749 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
2750 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
2751 append( sb, "", 0 );
2752
2753 append( sb, "footer", 2 );
2754 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
2755 append( sb, "Expression: ${footer}", 3 );
2756 append( sb, "", 0 );
2757
2758 append( sb, "groups", 2 );
2759 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
2760 append( sb, "Expression: ${groups}", 3 );
2761 append( sb, "", 0 );
2762
2763 append( sb, "header", 2 );
2764 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
2765 append( sb, "Expression: ${header}", 3 );
2766 append( sb, "", 0 );
2767
2768 append( sb, "helpfile", 2 );
2769 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
2770 append( sb, "Expression: ${helpfile}", 3 );
2771 append( sb, "", 0 );
2772
2773 append( sb, "includeDependencySources (Default: false)", 2 );
2774 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
2775 append( sb, "", 0 );
2776
2777 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
2778 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
2779 append( sb, "", 0 );
2780
2781 append( sb, "javaApiLinks", 2 );
2782 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
2783 append( sb, "Expression: ${javaApiLinks}", 3 );
2784 append( sb, "", 0 );
2785
2786 append( sb, "javadocDirectory", 2 );
2787 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
2788 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
2789 append( sb, "", 0 );
2790
2791 append( sb, "javadocExecutable", 2 );
2792 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
2793 append( sb, "Expression: ${javadocExecutable}", 3 );
2794 append( sb, "", 0 );
2795
2796 append( sb, "javadocVersion", 2 );
2797 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
2798 append( sb, "Expression: ${javadocVersion}", 3 );
2799 append( sb, "", 0 );
2800
2801 append( sb, "keywords (Default: false)", 2 );
2802 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
2803 append( sb, "Expression: ${keywords}", 3 );
2804 append( sb, "", 0 );
2805
2806 append( sb, "links", 2 );
2807 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
2808 append( sb, "Expression: ${links}", 3 );
2809 append( sb, "", 0 );
2810
2811 append( sb, "linksource (Default: false)", 2 );
2812 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
2813 append( sb, "Expression: ${linksource}", 3 );
2814 append( sb, "", 0 );
2815
2816 append( sb, "locale", 2 );
2817 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
2818 append( sb, "Expression: ${locale}", 3 );
2819 append( sb, "", 0 );
2820
2821 append( sb, "localRepository", 2 );
2822 append( sb, "The local repository where the artifacts are located.", 3 );
2823 append( sb, "Expression: ${localRepository}", 3 );
2824 append( sb, "", 0 );
2825
2826 append( sb, "maxmemory", 2 );
2827 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
2828 append( sb, "Expression: ${maxmemory}", 3 );
2829 append( sb, "", 0 );
2830
2831 append( sb, "minmemory", 2 );
2832 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
2833 append( sb, "Expression: ${minmemory}", 3 );
2834 append( sb, "", 0 );
2835
2836 append( sb, "name", 2 );
2837 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
2838 append( sb, "Expression: ${name}", 3 );
2839 append( sb, "", 0 );
2840
2841 append( sb, "nocomment (Default: false)", 2 );
2842 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
2843 append( sb, "Expression: ${nocomment}", 3 );
2844 append( sb, "", 0 );
2845
2846 append( sb, "nodeprecated (Default: false)", 2 );
2847 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
2848 append( sb, "Expression: ${nodeprecated}", 3 );
2849 append( sb, "", 0 );
2850
2851 append( sb, "nodeprecatedlist (Default: false)", 2 );
2852 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
2853 append( sb, "Expression: ${nodeprecatedlist}", 3 );
2854 append( sb, "", 0 );
2855
2856 append( sb, "nohelp (Default: false)", 2 );
2857 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
2858 append( sb, "Expression: ${nohelp}", 3 );
2859 append( sb, "", 0 );
2860
2861 append( sb, "noindex (Default: false)", 2 );
2862 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
2863 append( sb, "Expression: ${noindex}", 3 );
2864 append( sb, "", 0 );
2865
2866 append( sb, "nonavbar (Default: false)", 2 );
2867 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
2868 append( sb, "Expression: ${nonavbar}", 3 );
2869 append( sb, "", 0 );
2870
2871 append( sb, "nooverview (Default: false)", 2 );
2872 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
2873 append( sb, "Expression: ${nooverview}", 3 );
2874 append( sb, "", 0 );
2875
2876 append( sb, "noqualifier", 2 );
2877 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
2878 append( sb, "Expression: ${noqualifier}", 3 );
2879 append( sb, "", 0 );
2880
2881 append( sb, "nosince (Default: false)", 2 );
2882 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
2883 append( sb, "Expression: ${nosince}", 3 );
2884 append( sb, "", 0 );
2885
2886 append( sb, "notimestamp (Default: false)", 2 );
2887 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
2888 append( sb, "Expression: ${notimestamp}", 3 );
2889 append( sb, "", 0 );
2890
2891 append( sb, "notree (Default: false)", 2 );
2892 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
2893 append( sb, "Expression: ${notree}", 3 );
2894 append( sb, "", 0 );
2895
2896 append( sb, "offlineLinks", 2 );
2897 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
2898 append( sb, "Expression: ${offlineLinks}", 3 );
2899 append( sb, "", 0 );
2900
2901 append( sb, "old (Default: false)", 2 );
2902 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
2903 append( sb, "Expression: ${old}", 3 );
2904 append( sb, "", 0 );
2905
2906 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
2907 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
2908 append( sb, "Required: Yes", 3 );
2909 append( sb, "Expression: ${destDir}", 3 );
2910 append( sb, "", 0 );
2911
2912 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
2913 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
2914 append( sb, "Expression: ${overview}", 3 );
2915 append( sb, "", 0 );
2916
2917 append( sb, "packagesheader", 2 );
2918 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
2919 append( sb, "Expression: ${packagesheader}", 3 );
2920 append( sb, "", 0 );
2921
2922 append( sb, "proxyHost", 2 );
2923 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
2924 append( sb, "", 0 );
2925 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
2926 append( sb, "Expression: ${proxyHost}", 3 );
2927 append( sb, "", 0 );
2928
2929 append( sb, "proxyPort", 2 );
2930 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
2931 append( sb, "", 0 );
2932 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
2933 append( sb, "Expression: ${proxyPort}", 3 );
2934 append( sb, "", 0 );
2935
2936 append( sb, "quiet (Default: false)", 2 );
2937 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
2938 append( sb, "Expression: ${quiet}", 3 );
2939 append( sb, "", 0 );
2940
2941 append( sb, "remoteRepositories", 2 );
2942 append( sb, "The remote repositories where artifacts are located.", 3 );
2943 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
2944 append( sb, "", 0 );
2945
2946 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
2947 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
2948 append( sb, "Required: Yes", 3 );
2949 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
2950 append( sb, "", 0 );
2951
2952 append( sb, "resourcesArtifacts", 2 );
2953 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
2954 append( sb, "Expression: ${resourcesArtifacts}", 3 );
2955 append( sb, "", 0 );
2956
2957 append( sb, "serialwarn (Default: false)", 2 );
2958 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
2959 append( sb, "Expression: ${serialwarn}", 3 );
2960 append( sb, "", 0 );
2961
2962 append( sb, "show (Default: protected)", 2 );
2963 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
2964 append( sb, "Expression: ${show}", 3 );
2965 append( sb, "", 0 );
2966
2967 append( sb, "skip (Default: false)", 2 );
2968 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
2969 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
2970 append( sb, "", 0 );
2971
2972 append( sb, "source", 2 );
2973 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
2974 append( sb, "Expression: ${source}", 3 );
2975 append( sb, "", 0 );
2976
2977 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
2978 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
2979 append( sb, "", 0 );
2980
2981 append( sb, "sourcepath", 2 );
2982 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
2983 append( sb, "Expression: ${sourcepath}", 3 );
2984 append( sb, "", 0 );
2985
2986 append( sb, "sourcetab", 2 );
2987 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
2988 append( sb, "Expression: ${sourcetab}", 3 );
2989 append( sb, "", 0 );
2990
2991 append( sb, "splitindex (Default: false)", 2 );
2992 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
2993 append( sb, "Expression: ${splitindex}", 3 );
2994 append( sb, "", 0 );
2995
2996 append( sb, "stylesheet (Default: java)", 2 );
2997 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
2998 append( sb, "Expression: ${stylesheet}", 3 );
2999 append( sb, "", 0 );
3000
3001 append( sb, "stylesheetfile", 2 );
3002 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
3003 append( sb, "Expression: ${stylesheetfile}", 3 );
3004 append( sb, "", 0 );
3005
3006 append( sb, "subpackages", 2 );
3007 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
3008 append( sb, "Expression: ${subpackages}", 3 );
3009 append( sb, "", 0 );
3010
3011 append( sb, "taglet", 2 );
3012 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
3013 append( sb, "Expression: ${taglet}", 3 );
3014 append( sb, "", 0 );
3015
3016 append( sb, "tagletArtifact", 2 );
3017 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
3018 append( sb, "Expression: ${tagletArtifact}", 3 );
3019 append( sb, "", 0 );
3020
3021 append( sb, "tagletArtifacts", 2 );
3022 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
3023 append( sb, "Expression: ${tagletArtifacts}", 3 );
3024 append( sb, "", 0 );
3025
3026 append( sb, "tagletpath", 2 );
3027 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
3028 append( sb, "Expression: ${tagletpath}", 3 );
3029 append( sb, "", 0 );
3030
3031 append( sb, "taglets", 2 );
3032 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
3033 append( sb, "Expression: ${taglets}", 3 );
3034 append( sb, "", 0 );
3035
3036 append( sb, "tags", 2 );
3037 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
3038 append( sb, "Expression: ${tags}", 3 );
3039 append( sb, "", 0 );
3040
3041 append( sb, "testDescription", 2 );
3042 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
3043 append( sb, "Expression: ${testDescription}", 3 );
3044 append( sb, "", 0 );
3045
3046 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
3047 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3048 append( sb, "Expression: ${testDoctitle}", 3 );
3049 append( sb, "", 0 );
3050
3051 append( sb, "testJavadocDirectory", 2 );
3052 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
3053 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
3054 append( sb, "", 0 );
3055
3056 append( sb, "testName", 2 );
3057 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
3058 append( sb, "Expression: ${testName}", 3 );
3059 append( sb, "", 0 );
3060
3061 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
3062 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
3063 append( sb, "Expression: ${testOverview}", 3 );
3064 append( sb, "", 0 );
3065
3066 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
3067 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3068 append( sb, "Expression: ${testWindowtitle}", 3 );
3069 append( sb, "", 0 );
3070
3071 append( sb, "top", 2 );
3072 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
3073 append( sb, "Expression: ${top}", 3 );
3074 append( sb, "", 0 );
3075
3076 append( sb, "use (Default: true)", 2 );
3077 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
3078 append( sb, "Expression: ${use}", 3 );
3079 append( sb, "", 0 );
3080
3081 append( sb, "useStandardDocletOptions (Default: true)", 2 );
3082 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
3083 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
3084 append( sb, "", 0 );
3085
3086 append( sb, "validateLinks (Default: false)", 2 );
3087 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
3088 append( sb, "Expression: ${validateLinks}", 3 );
3089 append( sb, "", 0 );
3090
3091 append( sb, "verbose (Default: false)", 2 );
3092 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
3093 append( sb, "Expression: ${verbose}", 3 );
3094 append( sb, "", 0 );
3095
3096 append( sb, "version (Default: true)", 2 );
3097 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
3098 append( sb, "Expression: ${version}", 3 );
3099 append( sb, "", 0 );
3100
3101 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
3102 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3103 append( sb, "Expression: ${windowtitle}", 3 );
3104 append( sb, "", 0 );
3105 }
3106 }
3107
3108 if ( goal == null || goal.length() <= 0 || "test-aggregate-jar".equals( goal ) )
3109 {
3110 append( sb, "javadoc:test-aggregate-jar", 0 );
3111 append( sb, "Bundles the Javadoc documentation for Java Test code in an aggregator project into a jar using the standard Javadoc Tool.", 1 );
3112 append( sb, "", 0 );
3113 if ( detail )
3114 {
3115 append( sb, "Available parameters:", 1 );
3116 append( sb, "", 0 );
3117
3118 append( sb, "additionalJOption", 2 );
3119 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
3120 append( sb, "Expression: ${additionalJOption}", 3 );
3121 append( sb, "", 0 );
3122
3123 append( sb, "additionalparam", 2 );
3124 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
3125 append( sb, "Expression: ${additionalparam}", 3 );
3126 append( sb, "", 0 );
3127
3128 append( sb, "aggregate (Default: false)", 2 );
3129 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
3130 append( sb, "", 0 );
3131 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
3132 append( sb, "Expression: ${aggregate}", 3 );
3133 append( sb, "", 0 );
3134
3135 append( sb, "archive", 2 );
3136 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
3137 append( sb, "", 0 );
3138
3139 append( sb, "attach (Default: true)", 2 );
3140 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
3141 append( sb, "Expression: ${attach}", 3 );
3142 append( sb, "", 0 );
3143
3144 append( sb, "author (Default: true)", 2 );
3145 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
3146 append( sb, "Expression: ${author}", 3 );
3147 append( sb, "", 0 );
3148
3149 append( sb, "bootclasspath", 2 );
3150 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
3151 append( sb, "Expression: ${bootclasspath}", 3 );
3152 append( sb, "", 0 );
3153
3154 append( sb, "bootclasspathArtifacts", 2 );
3155 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
3156 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
3157 append( sb, "", 0 );
3158
3159 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
3160 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
3161 append( sb, "Expression: ${bottom}", 3 );
3162 append( sb, "", 0 );
3163
3164 append( sb, "breakiterator (Default: false)", 2 );
3165 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
3166 append( sb, "Expression: ${breakiterator}", 3 );
3167 append( sb, "", 0 );
3168
3169 append( sb, "charset", 2 );
3170 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
3171 append( sb, "Expression: ${charset}", 3 );
3172 append( sb, "", 0 );
3173
3174 append( sb, "debug (Default: false)", 2 );
3175 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
3176 append( sb, "Expression: ${debug}", 3 );
3177 append( sb, "", 0 );
3178
3179 append( sb, "dependencySourceExcludes", 2 );
3180 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
3181 append( sb, "", 0 );
3182
3183 append( sb, "dependencySourceIncludes", 2 );
3184 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
3185 append( sb, "", 0 );
3186
3187 append( sb, "destDir", 2 );
3188 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
3189 append( sb, "Expression: ${destDir}", 3 );
3190 append( sb, "", 0 );
3191
3192 append( sb, "detectJavaApiLink (Default: true)", 2 );
3193 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
3194 append( sb, "Expression: ${detectJavaApiLink}", 3 );
3195 append( sb, "", 0 );
3196
3197 append( sb, "detectLinks (Default: false)", 2 );
3198 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
3199 append( sb, "Expression: ${detectLinks}", 3 );
3200 append( sb, "", 0 );
3201
3202 append( sb, "detectOfflineLinks (Default: true)", 2 );
3203 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
3204 append( sb, "Expression: ${detectOfflineLinks}", 3 );
3205 append( sb, "", 0 );
3206
3207 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
3208 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
3209 append( sb, "Expression: ${docencoding}", 3 );
3210 append( sb, "", 0 );
3211
3212 append( sb, "docfilessubdirs (Default: false)", 2 );
3213 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
3214 append( sb, "Expression: ${docfilessubdirs}", 3 );
3215 append( sb, "", 0 );
3216
3217 append( sb, "doclet", 2 );
3218 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
3219 append( sb, "Expression: ${doclet}", 3 );
3220 append( sb, "", 0 );
3221
3222 append( sb, "docletArtifact", 2 );
3223 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
3224 append( sb, "Expression: ${docletArtifact}", 3 );
3225 append( sb, "", 0 );
3226
3227 append( sb, "docletArtifacts", 2 );
3228 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
3229 append( sb, "Expression: ${docletArtifacts}", 3 );
3230 append( sb, "", 0 );
3231
3232 append( sb, "docletPath", 2 );
3233 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
3234 append( sb, "Expression: ${docletPath}", 3 );
3235 append( sb, "", 0 );
3236
3237 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
3238 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3239 append( sb, "Expression: ${doctitle}", 3 );
3240 append( sb, "", 0 );
3241
3242 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3243 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
3244 append( sb, "Expression: ${encoding}", 3 );
3245 append( sb, "", 0 );
3246
3247 append( sb, "excludedocfilessubdir", 2 );
3248 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
3249 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
3250 append( sb, "", 0 );
3251
3252 append( sb, "excludePackageNames", 2 );
3253 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
3254 append( sb, "Expression: ${excludePackageNames}", 3 );
3255 append( sb, "", 0 );
3256
3257 append( sb, "extdirs", 2 );
3258 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
3259 append( sb, "Expression: ${extdirs}", 3 );
3260 append( sb, "", 0 );
3261
3262 append( sb, "failOnError (Default: true)", 2 );
3263 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
3264 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
3265 append( sb, "", 0 );
3266
3267 append( sb, "finalName", 2 );
3268 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
3269 append( sb, "Expression: ${project.build.finalName}", 3 );
3270 append( sb, "", 0 );
3271
3272 append( sb, "footer", 2 );
3273 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
3274 append( sb, "Expression: ${footer}", 3 );
3275 append( sb, "", 0 );
3276
3277 append( sb, "groups", 2 );
3278 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
3279 append( sb, "Expression: ${groups}", 3 );
3280 append( sb, "", 0 );
3281
3282 append( sb, "header", 2 );
3283 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
3284 append( sb, "Expression: ${header}", 3 );
3285 append( sb, "", 0 );
3286
3287 append( sb, "helpfile", 2 );
3288 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
3289 append( sb, "Expression: ${helpfile}", 3 );
3290 append( sb, "", 0 );
3291
3292 append( sb, "includeDependencySources (Default: false)", 2 );
3293 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
3294 append( sb, "", 0 );
3295
3296 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
3297 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
3298 append( sb, "", 0 );
3299
3300 append( sb, "jarOutputDirectory", 2 );
3301 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
3302 append( sb, "Expression: ${project.build.directory}", 3 );
3303 append( sb, "", 0 );
3304
3305 append( sb, "javaApiLinks", 2 );
3306 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
3307 append( sb, "Expression: ${javaApiLinks}", 3 );
3308 append( sb, "", 0 );
3309
3310 append( sb, "javadocDirectory", 2 );
3311 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
3312 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
3313 append( sb, "", 0 );
3314
3315 append( sb, "javadocExecutable", 2 );
3316 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
3317 append( sb, "Expression: ${javadocExecutable}", 3 );
3318 append( sb, "", 0 );
3319
3320 append( sb, "javadocVersion", 2 );
3321 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
3322 append( sb, "Expression: ${javadocVersion}", 3 );
3323 append( sb, "", 0 );
3324
3325 append( sb, "keywords (Default: false)", 2 );
3326 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
3327 append( sb, "Expression: ${keywords}", 3 );
3328 append( sb, "", 0 );
3329
3330 append( sb, "links", 2 );
3331 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
3332 append( sb, "Expression: ${links}", 3 );
3333 append( sb, "", 0 );
3334
3335 append( sb, "linksource (Default: false)", 2 );
3336 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
3337 append( sb, "Expression: ${linksource}", 3 );
3338 append( sb, "", 0 );
3339
3340 append( sb, "locale", 2 );
3341 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
3342 append( sb, "Expression: ${locale}", 3 );
3343 append( sb, "", 0 );
3344
3345 append( sb, "localRepository", 2 );
3346 append( sb, "The local repository where the artifacts are located.", 3 );
3347 append( sb, "Expression: ${localRepository}", 3 );
3348 append( sb, "", 0 );
3349
3350 append( sb, "maxmemory", 2 );
3351 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
3352 append( sb, "Expression: ${maxmemory}", 3 );
3353 append( sb, "", 0 );
3354
3355 append( sb, "minmemory", 2 );
3356 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
3357 append( sb, "Expression: ${minmemory}", 3 );
3358 append( sb, "", 0 );
3359
3360 append( sb, "nocomment (Default: false)", 2 );
3361 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
3362 append( sb, "Expression: ${nocomment}", 3 );
3363 append( sb, "", 0 );
3364
3365 append( sb, "nodeprecated (Default: false)", 2 );
3366 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
3367 append( sb, "Expression: ${nodeprecated}", 3 );
3368 append( sb, "", 0 );
3369
3370 append( sb, "nodeprecatedlist (Default: false)", 2 );
3371 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
3372 append( sb, "Expression: ${nodeprecatedlist}", 3 );
3373 append( sb, "", 0 );
3374
3375 append( sb, "nohelp (Default: false)", 2 );
3376 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
3377 append( sb, "Expression: ${nohelp}", 3 );
3378 append( sb, "", 0 );
3379
3380 append( sb, "noindex (Default: false)", 2 );
3381 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
3382 append( sb, "Expression: ${noindex}", 3 );
3383 append( sb, "", 0 );
3384
3385 append( sb, "nonavbar (Default: false)", 2 );
3386 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
3387 append( sb, "Expression: ${nonavbar}", 3 );
3388 append( sb, "", 0 );
3389
3390 append( sb, "nooverview (Default: false)", 2 );
3391 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
3392 append( sb, "Expression: ${nooverview}", 3 );
3393 append( sb, "", 0 );
3394
3395 append( sb, "noqualifier", 2 );
3396 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
3397 append( sb, "Expression: ${noqualifier}", 3 );
3398 append( sb, "", 0 );
3399
3400 append( sb, "nosince (Default: false)", 2 );
3401 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
3402 append( sb, "Expression: ${nosince}", 3 );
3403 append( sb, "", 0 );
3404
3405 append( sb, "notimestamp (Default: false)", 2 );
3406 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
3407 append( sb, "Expression: ${notimestamp}", 3 );
3408 append( sb, "", 0 );
3409
3410 append( sb, "notree (Default: false)", 2 );
3411 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
3412 append( sb, "Expression: ${notree}", 3 );
3413 append( sb, "", 0 );
3414
3415 append( sb, "offlineLinks", 2 );
3416 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
3417 append( sb, "Expression: ${offlineLinks}", 3 );
3418 append( sb, "", 0 );
3419
3420 append( sb, "old (Default: false)", 2 );
3421 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
3422 append( sb, "Expression: ${old}", 3 );
3423 append( sb, "", 0 );
3424
3425 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
3426 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
3427 append( sb, "Required: Yes", 3 );
3428 append( sb, "", 0 );
3429
3430 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
3431 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
3432 append( sb, "Expression: ${overview}", 3 );
3433 append( sb, "", 0 );
3434
3435 append( sb, "packagesheader", 2 );
3436 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
3437 append( sb, "Expression: ${packagesheader}", 3 );
3438 append( sb, "", 0 );
3439
3440 append( sb, "proxyHost", 2 );
3441 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
3442 append( sb, "", 0 );
3443 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
3444 append( sb, "Expression: ${proxyHost}", 3 );
3445 append( sb, "", 0 );
3446
3447 append( sb, "proxyPort", 2 );
3448 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
3449 append( sb, "", 0 );
3450 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
3451 append( sb, "Expression: ${proxyPort}", 3 );
3452 append( sb, "", 0 );
3453
3454 append( sb, "quiet (Default: false)", 2 );
3455 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
3456 append( sb, "Expression: ${quiet}", 3 );
3457 append( sb, "", 0 );
3458
3459 append( sb, "remoteRepositories", 2 );
3460 append( sb, "The remote repositories where artifacts are located.", 3 );
3461 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
3462 append( sb, "", 0 );
3463
3464 append( sb, "resourcesArtifacts", 2 );
3465 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
3466 append( sb, "Expression: ${resourcesArtifacts}", 3 );
3467 append( sb, "", 0 );
3468
3469 append( sb, "serialwarn (Default: false)", 2 );
3470 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
3471 append( sb, "Expression: ${serialwarn}", 3 );
3472 append( sb, "", 0 );
3473
3474 append( sb, "show (Default: protected)", 2 );
3475 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
3476 append( sb, "Expression: ${show}", 3 );
3477 append( sb, "", 0 );
3478
3479 append( sb, "skip (Default: false)", 2 );
3480 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
3481 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
3482 append( sb, "", 0 );
3483
3484 append( sb, "source", 2 );
3485 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
3486 append( sb, "Expression: ${source}", 3 );
3487 append( sb, "", 0 );
3488
3489 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
3490 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
3491 append( sb, "", 0 );
3492
3493 append( sb, "sourcepath", 2 );
3494 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
3495 append( sb, "Expression: ${sourcepath}", 3 );
3496 append( sb, "", 0 );
3497
3498 append( sb, "sourcetab", 2 );
3499 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
3500 append( sb, "Expression: ${sourcetab}", 3 );
3501 append( sb, "", 0 );
3502
3503 append( sb, "splitindex (Default: false)", 2 );
3504 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
3505 append( sb, "Expression: ${splitindex}", 3 );
3506 append( sb, "", 0 );
3507
3508 append( sb, "stylesheet (Default: java)", 2 );
3509 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
3510 append( sb, "Expression: ${stylesheet}", 3 );
3511 append( sb, "", 0 );
3512
3513 append( sb, "stylesheetfile", 2 );
3514 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
3515 append( sb, "Expression: ${stylesheetfile}", 3 );
3516 append( sb, "", 0 );
3517
3518 append( sb, "subpackages", 2 );
3519 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
3520 append( sb, "Expression: ${subpackages}", 3 );
3521 append( sb, "", 0 );
3522
3523 append( sb, "taglet", 2 );
3524 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
3525 append( sb, "Expression: ${taglet}", 3 );
3526 append( sb, "", 0 );
3527
3528 append( sb, "tagletArtifact", 2 );
3529 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
3530 append( sb, "Expression: ${tagletArtifact}", 3 );
3531 append( sb, "", 0 );
3532
3533 append( sb, "tagletArtifacts", 2 );
3534 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
3535 append( sb, "Expression: ${tagletArtifacts}", 3 );
3536 append( sb, "", 0 );
3537
3538 append( sb, "tagletpath", 2 );
3539 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
3540 append( sb, "Expression: ${tagletpath}", 3 );
3541 append( sb, "", 0 );
3542
3543 append( sb, "taglets", 2 );
3544 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
3545 append( sb, "Expression: ${taglets}", 3 );
3546 append( sb, "", 0 );
3547
3548 append( sb, "tags", 2 );
3549 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
3550 append( sb, "Expression: ${tags}", 3 );
3551 append( sb, "", 0 );
3552
3553 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
3554 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3555 append( sb, "Expression: ${testDoctitle}", 3 );
3556 append( sb, "", 0 );
3557
3558 append( sb, "testJavadocDirectory", 2 );
3559 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
3560 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
3561 append( sb, "", 0 );
3562
3563 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
3564 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nSee overview.\n", 3 );
3565 append( sb, "Expression: ${testOverview}", 3 );
3566 append( sb, "", 0 );
3567
3568 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
3569 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3570 append( sb, "Expression: ${testWindowtitle}", 3 );
3571 append( sb, "", 0 );
3572
3573 append( sb, "top", 2 );
3574 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
3575 append( sb, "Expression: ${top}", 3 );
3576 append( sb, "", 0 );
3577
3578 append( sb, "use (Default: true)", 2 );
3579 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
3580 append( sb, "Expression: ${use}", 3 );
3581 append( sb, "", 0 );
3582
3583 append( sb, "useDefaultManifestFile (Default: false)", 2 );
3584 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
3585 append( sb, "", 0 );
3586
3587 append( sb, "useStandardDocletOptions (Default: true)", 2 );
3588 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
3589 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
3590 append( sb, "", 0 );
3591
3592 append( sb, "validateLinks (Default: false)", 2 );
3593 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
3594 append( sb, "Expression: ${validateLinks}", 3 );
3595 append( sb, "", 0 );
3596
3597 append( sb, "verbose (Default: false)", 2 );
3598 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
3599 append( sb, "Expression: ${verbose}", 3 );
3600 append( sb, "", 0 );
3601
3602 append( sb, "version (Default: true)", 2 );
3603 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
3604 append( sb, "Expression: ${version}", 3 );
3605 append( sb, "", 0 );
3606
3607 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
3608 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
3609 append( sb, "Expression: ${windowtitle}", 3 );
3610 append( sb, "", 0 );
3611 }
3612 }
3613
3614 if ( goal == null || goal.length() <= 0 || "test-fix".equals( goal ) )
3615 {
3616 append( sb, "javadoc:test-fix", 0 );
3617 append( sb, "Fix Javadoc documentation and tags for the Test Java code for the project. See Where Tags Can Be Used.", 1 );
3618 append( sb, "", 0 );
3619 if ( detail )
3620 {
3621 append( sb, "Available parameters:", 1 );
3622 append( sb, "", 0 );
3623
3624 append( sb, "comparisonVersion (Default: (,${project.version}))", 2 );
3625 append( sb, "Version to compare the current code against using the Clirr Maven Plugin.\nSee defaultSince.", 3 );
3626 append( sb, "Expression: ${comparisonVersion}", 3 );
3627 append( sb, "", 0 );
3628
3629 append( sb, "defaultAuthor", 2 );
3630 append( sb, "Default value for the Javadoc tag @author.\nIf not specified, the user.name defined in the System properties will be used.", 3 );
3631 append( sb, "Expression: ${defaultAuthor}", 3 );
3632 append( sb, "", 0 );
3633
3634 append( sb, "defaultSince (Default: ${project.version})", 2 );
3635 append( sb, "Default value for the Javadoc tag @since.\n", 3 );
3636 append( sb, "Expression: ${defaultSince}", 3 );
3637 append( sb, "", 0 );
3638
3639 append( sb, "defaultVersion", 2 );
3640 append( sb, "Default value for the Javadoc tag @version.\nBy default, it is $Id$, corresponding to a SVN keyword. Refer to your SCM to use an other SCM keyword.", 3 );
3641 append( sb, "Expression: ${defaultVersion}", 3 );
3642 append( sb, "", 0 );
3643
3644 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3645 append( sb, "The file encoding to use when reading the source files. If the property project.build.sourceEncoding is not set, the platform default encoding is used.", 3 );
3646 append( sb, "Expression: ${encoding}", 3 );
3647 append( sb, "", 0 );
3648
3649 append( sb, "excludes", 2 );
3650 append( sb, "Comma separated excludes Java files, i.e. **/*Test.java.", 3 );
3651 append( sb, "Expression: ${excludes}", 3 );
3652 append( sb, "", 0 );
3653
3654 append( sb, "fixClassComment (Default: true)", 2 );
3655 append( sb, "Flag to fix the classes or interfaces Javadoc comments according the level.", 3 );
3656 append( sb, "Expression: ${fixClassComment}", 3 );
3657 append( sb, "", 0 );
3658
3659 append( sb, "fixFieldComment (Default: true)", 2 );
3660 append( sb, "Flag to fix the fields Javadoc comments according the level.", 3 );
3661 append( sb, "Expression: ${fixFieldComment}", 3 );
3662 append( sb, "", 0 );
3663
3664 append( sb, "fixMethodComment (Default: true)", 2 );
3665 append( sb, "Flag to fix the methods Javadoc comments according the level.", 3 );
3666 append( sb, "Expression: ${fixMethodComment}", 3 );
3667 append( sb, "", 0 );
3668
3669 append( sb, "fixTags (Default: all)", 2 );
3670 append( sb, "Comma separated tags to fix in classes, interfaces or methods Javadoc comments. Possible values are:\n-\tall (fix all Javadoc tags)\n-\tauthor (fix only @author tag)\n-\tversion (fix only @version tag)\n-\tsince (fix only @since tag)\n-\tparam (fix only @param tag)\n-\treturn (fix only @return tag)\n-\tthrows (fix only @throws tag)\n", 3 );
3671 append( sb, "Expression: ${fixTags}", 3 );
3672 append( sb, "", 0 );
3673
3674 append( sb, "force", 2 );
3675 append( sb, "Forcing the goal execution i.e. skip warranty messages (not recommended).", 3 );
3676 append( sb, "Expression: ${force}", 3 );
3677 append( sb, "", 0 );
3678
3679 append( sb, "ignoreClirr (Default: false)", 2 );
3680 append( sb, "Flag to ignore or not Clirr.", 3 );
3681 append( sb, "Expression: ${ignoreClirr}", 3 );
3682 append( sb, "", 0 );
3683
3684 append( sb, "includes (Default: **/*.java)", 2 );
3685 append( sb, "Comma separated includes Java files, i.e. **/*Test.java.", 3 );
3686 append( sb, "Expression: ${includes}", 3 );
3687 append( sb, "", 0 );
3688
3689 append( sb, "level (Default: protected)", 2 );
3690 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
3691 append( sb, "Expression: ${level}", 3 );
3692 append( sb, "", 0 );
3693
3694 append( sb, "localRepository", 2 );
3695 append( sb, "The local repository where the artifacts are located, used by the tests.", 3 );
3696 append( sb, "Expression: ${localRepository}", 3 );
3697 append( sb, "", 0 );
3698
3699 append( sb, "outputDirectory (Default: ${project.build.sourceDirectory})", 2 );
3700 append( sb, "Output directory where Java classes will be rewritten.", 3 );
3701 append( sb, "Expression: ${outputDirectory}", 3 );
3702 append( sb, "", 0 );
3703 }
3704 }
3705
3706 if ( goal == null || goal.length() <= 0 || "test-jar".equals( goal ) )
3707 {
3708 append( sb, "javadoc:test-jar", 0 );
3709 append( sb, "Bundles the Javadoc documentation for test Java code in an NON aggregator project into a jar using the standard Javadoc Tool.", 1 );
3710 append( sb, "", 0 );
3711 if ( detail )
3712 {
3713 append( sb, "Available parameters:", 1 );
3714 append( sb, "", 0 );
3715
3716 append( sb, "additionalJOption", 2 );
3717 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
3718 append( sb, "Expression: ${additionalJOption}", 3 );
3719 append( sb, "", 0 );
3720
3721 append( sb, "additionalparam", 2 );
3722 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
3723 append( sb, "Expression: ${additionalparam}", 3 );
3724 append( sb, "", 0 );
3725
3726 append( sb, "aggregate (Default: false)", 2 );
3727 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
3728 append( sb, "", 0 );
3729 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
3730 append( sb, "Expression: ${aggregate}", 3 );
3731 append( sb, "", 0 );
3732
3733 append( sb, "archive", 2 );
3734 append( sb, "The archive configuration to use. See Maven Archiver Reference.", 3 );
3735 append( sb, "", 0 );
3736
3737 append( sb, "attach (Default: true)", 2 );
3738 append( sb, "Specifies whether to attach the generated artifact to the project helper.\n", 3 );
3739 append( sb, "Expression: ${attach}", 3 );
3740 append( sb, "", 0 );
3741
3742 append( sb, "author (Default: true)", 2 );
3743 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
3744 append( sb, "Expression: ${author}", 3 );
3745 append( sb, "", 0 );
3746
3747 append( sb, "bootclasspath", 2 );
3748 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
3749 append( sb, "Expression: ${bootclasspath}", 3 );
3750 append( sb, "", 0 );
3751
3752 append( sb, "bootclasspathArtifacts", 2 );
3753 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
3754 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
3755 append( sb, "", 0 );
3756
3757 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
3758 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
3759 append( sb, "Expression: ${bottom}", 3 );
3760 append( sb, "", 0 );
3761
3762 append( sb, "breakiterator (Default: false)", 2 );
3763 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
3764 append( sb, "Expression: ${breakiterator}", 3 );
3765 append( sb, "", 0 );
3766
3767 append( sb, "charset", 2 );
3768 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
3769 append( sb, "Expression: ${charset}", 3 );
3770 append( sb, "", 0 );
3771
3772 append( sb, "debug (Default: false)", 2 );
3773 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
3774 append( sb, "Expression: ${debug}", 3 );
3775 append( sb, "", 0 );
3776
3777 append( sb, "dependencySourceExcludes", 2 );
3778 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
3779 append( sb, "", 0 );
3780
3781 append( sb, "dependencySourceIncludes", 2 );
3782 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
3783 append( sb, "", 0 );
3784
3785 append( sb, "destDir", 2 );
3786 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files. See d.", 3 );
3787 append( sb, "Expression: ${destDir}", 3 );
3788 append( sb, "", 0 );
3789
3790 append( sb, "detectJavaApiLink (Default: true)", 2 );
3791 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
3792 append( sb, "Expression: ${detectJavaApiLink}", 3 );
3793 append( sb, "", 0 );
3794
3795 append( sb, "detectLinks (Default: false)", 2 );
3796 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
3797 append( sb, "Expression: ${detectLinks}", 3 );
3798 append( sb, "", 0 );
3799
3800 append( sb, "detectOfflineLinks (Default: true)", 2 );
3801 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
3802 append( sb, "Expression: ${detectOfflineLinks}", 3 );
3803 append( sb, "", 0 );
3804
3805 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
3806 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
3807 append( sb, "Expression: ${docencoding}", 3 );
3808 append( sb, "", 0 );
3809
3810 append( sb, "docfilessubdirs (Default: false)", 2 );
3811 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
3812 append( sb, "Expression: ${docfilessubdirs}", 3 );
3813 append( sb, "", 0 );
3814
3815 append( sb, "doclet", 2 );
3816 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
3817 append( sb, "Expression: ${doclet}", 3 );
3818 append( sb, "", 0 );
3819
3820 append( sb, "docletArtifact", 2 );
3821 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
3822 append( sb, "Expression: ${docletArtifact}", 3 );
3823 append( sb, "", 0 );
3824
3825 append( sb, "docletArtifacts", 2 );
3826 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
3827 append( sb, "Expression: ${docletArtifacts}", 3 );
3828 append( sb, "", 0 );
3829
3830 append( sb, "docletPath", 2 );
3831 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
3832 append( sb, "Expression: ${docletPath}", 3 );
3833 append( sb, "", 0 );
3834
3835 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
3836 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
3837 append( sb, "Expression: ${doctitle}", 3 );
3838 append( sb, "", 0 );
3839
3840 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
3841 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
3842 append( sb, "Expression: ${encoding}", 3 );
3843 append( sb, "", 0 );
3844
3845 append( sb, "excludedocfilessubdir", 2 );
3846 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
3847 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
3848 append( sb, "", 0 );
3849
3850 append( sb, "excludePackageNames", 2 );
3851 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
3852 append( sb, "Expression: ${excludePackageNames}", 3 );
3853 append( sb, "", 0 );
3854
3855 append( sb, "extdirs", 2 );
3856 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
3857 append( sb, "Expression: ${extdirs}", 3 );
3858 append( sb, "", 0 );
3859
3860 append( sb, "failOnError (Default: true)", 2 );
3861 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
3862 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
3863 append( sb, "", 0 );
3864
3865 append( sb, "finalName", 2 );
3866 append( sb, "Specifies the filename that will be used for the generated jar file. Please note that -javadoc or -test-javadoc will be appended to the file name.", 3 );
3867 append( sb, "Expression: ${project.build.finalName}", 3 );
3868 append( sb, "", 0 );
3869
3870 append( sb, "footer", 2 );
3871 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
3872 append( sb, "Expression: ${footer}", 3 );
3873 append( sb, "", 0 );
3874
3875 append( sb, "groups", 2 );
3876 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
3877 append( sb, "Expression: ${groups}", 3 );
3878 append( sb, "", 0 );
3879
3880 append( sb, "header", 2 );
3881 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
3882 append( sb, "Expression: ${header}", 3 );
3883 append( sb, "", 0 );
3884
3885 append( sb, "helpfile", 2 );
3886 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
3887 append( sb, "Expression: ${helpfile}", 3 );
3888 append( sb, "", 0 );
3889
3890 append( sb, "includeDependencySources (Default: false)", 2 );
3891 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
3892 append( sb, "", 0 );
3893
3894 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
3895 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
3896 append( sb, "", 0 );
3897
3898 append( sb, "jarOutputDirectory", 2 );
3899 append( sb, "Specifies the directory where the generated jar file will be put.", 3 );
3900 append( sb, "Expression: ${project.build.directory}", 3 );
3901 append( sb, "", 0 );
3902
3903 append( sb, "javaApiLinks", 2 );
3904 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
3905 append( sb, "Expression: ${javaApiLinks}", 3 );
3906 append( sb, "", 0 );
3907
3908 append( sb, "javadocDirectory", 2 );
3909 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
3910 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
3911 append( sb, "", 0 );
3912
3913 append( sb, "javadocExecutable", 2 );
3914 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
3915 append( sb, "Expression: ${javadocExecutable}", 3 );
3916 append( sb, "", 0 );
3917
3918 append( sb, "javadocVersion", 2 );
3919 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
3920 append( sb, "Expression: ${javadocVersion}", 3 );
3921 append( sb, "", 0 );
3922
3923 append( sb, "keywords (Default: false)", 2 );
3924 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
3925 append( sb, "Expression: ${keywords}", 3 );
3926 append( sb, "", 0 );
3927
3928 append( sb, "links", 2 );
3929 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
3930 append( sb, "Expression: ${links}", 3 );
3931 append( sb, "", 0 );
3932
3933 append( sb, "linksource (Default: false)", 2 );
3934 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
3935 append( sb, "Expression: ${linksource}", 3 );
3936 append( sb, "", 0 );
3937
3938 append( sb, "locale", 2 );
3939 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
3940 append( sb, "Expression: ${locale}", 3 );
3941 append( sb, "", 0 );
3942
3943 append( sb, "localRepository", 2 );
3944 append( sb, "The local repository where the artifacts are located.", 3 );
3945 append( sb, "Expression: ${localRepository}", 3 );
3946 append( sb, "", 0 );
3947
3948 append( sb, "maxmemory", 2 );
3949 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
3950 append( sb, "Expression: ${maxmemory}", 3 );
3951 append( sb, "", 0 );
3952
3953 append( sb, "minmemory", 2 );
3954 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
3955 append( sb, "Expression: ${minmemory}", 3 );
3956 append( sb, "", 0 );
3957
3958 append( sb, "nocomment (Default: false)", 2 );
3959 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
3960 append( sb, "Expression: ${nocomment}", 3 );
3961 append( sb, "", 0 );
3962
3963 append( sb, "nodeprecated (Default: false)", 2 );
3964 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
3965 append( sb, "Expression: ${nodeprecated}", 3 );
3966 append( sb, "", 0 );
3967
3968 append( sb, "nodeprecatedlist (Default: false)", 2 );
3969 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
3970 append( sb, "Expression: ${nodeprecatedlist}", 3 );
3971 append( sb, "", 0 );
3972
3973 append( sb, "nohelp (Default: false)", 2 );
3974 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
3975 append( sb, "Expression: ${nohelp}", 3 );
3976 append( sb, "", 0 );
3977
3978 append( sb, "noindex (Default: false)", 2 );
3979 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
3980 append( sb, "Expression: ${noindex}", 3 );
3981 append( sb, "", 0 );
3982
3983 append( sb, "nonavbar (Default: false)", 2 );
3984 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
3985 append( sb, "Expression: ${nonavbar}", 3 );
3986 append( sb, "", 0 );
3987
3988 append( sb, "nooverview (Default: false)", 2 );
3989 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
3990 append( sb, "Expression: ${nooverview}", 3 );
3991 append( sb, "", 0 );
3992
3993 append( sb, "noqualifier", 2 );
3994 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
3995 append( sb, "Expression: ${noqualifier}", 3 );
3996 append( sb, "", 0 );
3997
3998 append( sb, "nosince (Default: false)", 2 );
3999 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
4000 append( sb, "Expression: ${nosince}", 3 );
4001 append( sb, "", 0 );
4002
4003 append( sb, "notimestamp (Default: false)", 2 );
4004 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
4005 append( sb, "Expression: ${notimestamp}", 3 );
4006 append( sb, "", 0 );
4007
4008 append( sb, "notree (Default: false)", 2 );
4009 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
4010 append( sb, "Expression: ${notree}", 3 );
4011 append( sb, "", 0 );
4012
4013 append( sb, "offlineLinks", 2 );
4014 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
4015 append( sb, "Expression: ${offlineLinks}", 3 );
4016 append( sb, "", 0 );
4017
4018 append( sb, "old (Default: false)", 2 );
4019 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
4020 append( sb, "Expression: ${old}", 3 );
4021 append( sb, "", 0 );
4022
4023 append( sb, "outputDirectory (Default: ${project.build.directory}/testapidocs)", 2 );
4024 append( sb, "Specifies the destination directory where Javadoc saves the generated HTML files.\nSee d.\n", 3 );
4025 append( sb, "Required: Yes", 3 );
4026 append( sb, "", 0 );
4027
4028 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
4029 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
4030 append( sb, "Expression: ${overview}", 3 );
4031 append( sb, "", 0 );
4032
4033 append( sb, "packagesheader", 2 );
4034 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
4035 append( sb, "Expression: ${packagesheader}", 3 );
4036 append( sb, "", 0 );
4037
4038 append( sb, "proxyHost", 2 );
4039 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
4040 append( sb, "", 0 );
4041 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
4042 append( sb, "Expression: ${proxyHost}", 3 );
4043 append( sb, "", 0 );
4044
4045 append( sb, "proxyPort", 2 );
4046 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
4047 append( sb, "", 0 );
4048 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
4049 append( sb, "Expression: ${proxyPort}", 3 );
4050 append( sb, "", 0 );
4051
4052 append( sb, "quiet (Default: false)", 2 );
4053 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
4054 append( sb, "Expression: ${quiet}", 3 );
4055 append( sb, "", 0 );
4056
4057 append( sb, "remoteRepositories", 2 );
4058 append( sb, "The remote repositories where artifacts are located.", 3 );
4059 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
4060 append( sb, "", 0 );
4061
4062 append( sb, "resourcesArtifacts", 2 );
4063 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
4064 append( sb, "Expression: ${resourcesArtifacts}", 3 );
4065 append( sb, "", 0 );
4066
4067 append( sb, "serialwarn (Default: false)", 2 );
4068 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
4069 append( sb, "Expression: ${serialwarn}", 3 );
4070 append( sb, "", 0 );
4071
4072 append( sb, "show (Default: protected)", 2 );
4073 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
4074 append( sb, "Expression: ${show}", 3 );
4075 append( sb, "", 0 );
4076
4077 append( sb, "skip (Default: false)", 2 );
4078 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
4079 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
4080 append( sb, "", 0 );
4081
4082 append( sb, "source", 2 );
4083 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
4084 append( sb, "Expression: ${source}", 3 );
4085 append( sb, "", 0 );
4086
4087 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
4088 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
4089 append( sb, "", 0 );
4090
4091 append( sb, "sourcepath", 2 );
4092 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
4093 append( sb, "Expression: ${sourcepath}", 3 );
4094 append( sb, "", 0 );
4095
4096 append( sb, "sourcetab", 2 );
4097 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
4098 append( sb, "Expression: ${sourcetab}", 3 );
4099 append( sb, "", 0 );
4100
4101 append( sb, "splitindex (Default: false)", 2 );
4102 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
4103 append( sb, "Expression: ${splitindex}", 3 );
4104 append( sb, "", 0 );
4105
4106 append( sb, "stylesheet (Default: java)", 2 );
4107 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
4108 append( sb, "Expression: ${stylesheet}", 3 );
4109 append( sb, "", 0 );
4110
4111 append( sb, "stylesheetfile", 2 );
4112 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
4113 append( sb, "Expression: ${stylesheetfile}", 3 );
4114 append( sb, "", 0 );
4115
4116 append( sb, "subpackages", 2 );
4117 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
4118 append( sb, "Expression: ${subpackages}", 3 );
4119 append( sb, "", 0 );
4120
4121 append( sb, "taglet", 2 );
4122 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
4123 append( sb, "Expression: ${taglet}", 3 );
4124 append( sb, "", 0 );
4125
4126 append( sb, "tagletArtifact", 2 );
4127 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
4128 append( sb, "Expression: ${tagletArtifact}", 3 );
4129 append( sb, "", 0 );
4130
4131 append( sb, "tagletArtifacts", 2 );
4132 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
4133 append( sb, "Expression: ${tagletArtifacts}", 3 );
4134 append( sb, "", 0 );
4135
4136 append( sb, "tagletpath", 2 );
4137 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
4138 append( sb, "Expression: ${tagletpath}", 3 );
4139 append( sb, "", 0 );
4140
4141 append( sb, "taglets", 2 );
4142 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
4143 append( sb, "Expression: ${taglets}", 3 );
4144 append( sb, "", 0 );
4145
4146 append( sb, "tags", 2 );
4147 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
4148 append( sb, "Expression: ${tags}", 3 );
4149 append( sb, "", 0 );
4150
4151 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
4152 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4153 append( sb, "Expression: ${testDoctitle}", 3 );
4154 append( sb, "", 0 );
4155
4156 append( sb, "testJavadocDirectory", 2 );
4157 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
4158 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
4159 append( sb, "", 0 );
4160
4161 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
4162 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nSee overview.\n", 3 );
4163 append( sb, "Expression: ${testOverview}", 3 );
4164 append( sb, "", 0 );
4165
4166 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
4167 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4168 append( sb, "Expression: ${testWindowtitle}", 3 );
4169 append( sb, "", 0 );
4170
4171 append( sb, "top", 2 );
4172 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
4173 append( sb, "Expression: ${top}", 3 );
4174 append( sb, "", 0 );
4175
4176 append( sb, "use (Default: true)", 2 );
4177 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
4178 append( sb, "Expression: ${use}", 3 );
4179 append( sb, "", 0 );
4180
4181 append( sb, "useDefaultManifestFile (Default: false)", 2 );
4182 append( sb, "Set this to true to enable the use of the defaultManifestFile.\n", 3 );
4183 append( sb, "", 0 );
4184
4185 append( sb, "useStandardDocletOptions (Default: true)", 2 );
4186 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
4187 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
4188 append( sb, "", 0 );
4189
4190 append( sb, "validateLinks (Default: false)", 2 );
4191 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
4192 append( sb, "Expression: ${validateLinks}", 3 );
4193 append( sb, "", 0 );
4194
4195 append( sb, "verbose (Default: false)", 2 );
4196 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
4197 append( sb, "Expression: ${verbose}", 3 );
4198 append( sb, "", 0 );
4199
4200 append( sb, "version (Default: true)", 2 );
4201 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
4202 append( sb, "Expression: ${version}", 3 );
4203 append( sb, "", 0 );
4204
4205 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
4206 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4207 append( sb, "Expression: ${windowtitle}", 3 );
4208 append( sb, "", 0 );
4209 }
4210 }
4211
4212 if ( goal == null || goal.length() <= 0 || "test-javadoc".equals( goal ) )
4213 {
4214 append( sb, "javadoc:test-javadoc", 0 );
4215 append( sb, "Generates documentation for the Java Test code in an NON aggregator project using the standard Javadoc Tool.", 1 );
4216 append( sb, "", 0 );
4217 if ( detail )
4218 {
4219 append( sb, "Available parameters:", 1 );
4220 append( sb, "", 0 );
4221
4222 append( sb, "additionalJOption", 2 );
4223 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
4224 append( sb, "Expression: ${additionalJOption}", 3 );
4225 append( sb, "", 0 );
4226
4227 append( sb, "additionalparam", 2 );
4228 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
4229 append( sb, "Expression: ${additionalparam}", 3 );
4230 append( sb, "", 0 );
4231
4232 append( sb, "aggregate (Default: false)", 2 );
4233 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
4234 append( sb, "", 0 );
4235 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
4236 append( sb, "Expression: ${aggregate}", 3 );
4237 append( sb, "", 0 );
4238
4239 append( sb, "author (Default: true)", 2 );
4240 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
4241 append( sb, "Expression: ${author}", 3 );
4242 append( sb, "", 0 );
4243
4244 append( sb, "bootclasspath", 2 );
4245 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
4246 append( sb, "Expression: ${bootclasspath}", 3 );
4247 append( sb, "", 0 );
4248
4249 append( sb, "bootclasspathArtifacts", 2 );
4250 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
4251 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
4252 append( sb, "", 0 );
4253
4254 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
4255 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
4256 append( sb, "Expression: ${bottom}", 3 );
4257 append( sb, "", 0 );
4258
4259 append( sb, "breakiterator (Default: false)", 2 );
4260 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
4261 append( sb, "Expression: ${breakiterator}", 3 );
4262 append( sb, "", 0 );
4263
4264 append( sb, "charset", 2 );
4265 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
4266 append( sb, "Expression: ${charset}", 3 );
4267 append( sb, "", 0 );
4268
4269 append( sb, "debug (Default: false)", 2 );
4270 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
4271 append( sb, "Expression: ${debug}", 3 );
4272 append( sb, "", 0 );
4273
4274 append( sb, "dependencySourceExcludes", 2 );
4275 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
4276 append( sb, "", 0 );
4277
4278 append( sb, "dependencySourceIncludes", 2 );
4279 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
4280 append( sb, "", 0 );
4281
4282 append( sb, "description", 2 );
4283 append( sb, "The description of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4284 append( sb, "Expression: ${description}", 3 );
4285 append( sb, "", 0 );
4286
4287 append( sb, "destDir (Default: testapidocs)", 2 );
4288 append( sb, "The name of the destination directory.\n", 3 );
4289 append( sb, "Expression: ${destDir}", 3 );
4290 append( sb, "", 0 );
4291
4292 append( sb, "detectJavaApiLink (Default: true)", 2 );
4293 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
4294 append( sb, "Expression: ${detectJavaApiLink}", 3 );
4295 append( sb, "", 0 );
4296
4297 append( sb, "detectLinks (Default: false)", 2 );
4298 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
4299 append( sb, "Expression: ${detectLinks}", 3 );
4300 append( sb, "", 0 );
4301
4302 append( sb, "detectOfflineLinks (Default: true)", 2 );
4303 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
4304 append( sb, "Expression: ${detectOfflineLinks}", 3 );
4305 append( sb, "", 0 );
4306
4307 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
4308 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
4309 append( sb, "Expression: ${docencoding}", 3 );
4310 append( sb, "", 0 );
4311
4312 append( sb, "docfilessubdirs (Default: false)", 2 );
4313 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
4314 append( sb, "Expression: ${docfilessubdirs}", 3 );
4315 append( sb, "", 0 );
4316
4317 append( sb, "doclet", 2 );
4318 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
4319 append( sb, "Expression: ${doclet}", 3 );
4320 append( sb, "", 0 );
4321
4322 append( sb, "docletArtifact", 2 );
4323 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
4324 append( sb, "Expression: ${docletArtifact}", 3 );
4325 append( sb, "", 0 );
4326
4327 append( sb, "docletArtifacts", 2 );
4328 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
4329 append( sb, "Expression: ${docletArtifacts}", 3 );
4330 append( sb, "", 0 );
4331
4332 append( sb, "docletPath", 2 );
4333 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
4334 append( sb, "Expression: ${docletPath}", 3 );
4335 append( sb, "", 0 );
4336
4337 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
4338 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4339 append( sb, "Expression: ${doctitle}", 3 );
4340 append( sb, "", 0 );
4341
4342 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
4343 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
4344 append( sb, "Expression: ${encoding}", 3 );
4345 append( sb, "", 0 );
4346
4347 append( sb, "excludedocfilessubdir", 2 );
4348 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
4349 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
4350 append( sb, "", 0 );
4351
4352 append( sb, "excludePackageNames", 2 );
4353 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
4354 append( sb, "Expression: ${excludePackageNames}", 3 );
4355 append( sb, "", 0 );
4356
4357 append( sb, "extdirs", 2 );
4358 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
4359 append( sb, "Expression: ${extdirs}", 3 );
4360 append( sb, "", 0 );
4361
4362 append( sb, "failOnError (Default: true)", 2 );
4363 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
4364 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
4365 append( sb, "", 0 );
4366
4367 append( sb, "footer", 2 );
4368 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
4369 append( sb, "Expression: ${footer}", 3 );
4370 append( sb, "", 0 );
4371
4372 append( sb, "groups", 2 );
4373 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
4374 append( sb, "Expression: ${groups}", 3 );
4375 append( sb, "", 0 );
4376
4377 append( sb, "header", 2 );
4378 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
4379 append( sb, "Expression: ${header}", 3 );
4380 append( sb, "", 0 );
4381
4382 append( sb, "helpfile", 2 );
4383 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
4384 append( sb, "Expression: ${helpfile}", 3 );
4385 append( sb, "", 0 );
4386
4387 append( sb, "includeDependencySources (Default: false)", 2 );
4388 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
4389 append( sb, "", 0 );
4390
4391 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
4392 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
4393 append( sb, "", 0 );
4394
4395 append( sb, "javaApiLinks", 2 );
4396 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
4397 append( sb, "Expression: ${javaApiLinks}", 3 );
4398 append( sb, "", 0 );
4399
4400 append( sb, "javadocDirectory", 2 );
4401 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
4402 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
4403 append( sb, "", 0 );
4404
4405 append( sb, "javadocExecutable", 2 );
4406 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
4407 append( sb, "Expression: ${javadocExecutable}", 3 );
4408 append( sb, "", 0 );
4409
4410 append( sb, "javadocVersion", 2 );
4411 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
4412 append( sb, "Expression: ${javadocVersion}", 3 );
4413 append( sb, "", 0 );
4414
4415 append( sb, "keywords (Default: false)", 2 );
4416 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
4417 append( sb, "Expression: ${keywords}", 3 );
4418 append( sb, "", 0 );
4419
4420 append( sb, "links", 2 );
4421 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
4422 append( sb, "Expression: ${links}", 3 );
4423 append( sb, "", 0 );
4424
4425 append( sb, "linksource (Default: false)", 2 );
4426 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
4427 append( sb, "Expression: ${linksource}", 3 );
4428 append( sb, "", 0 );
4429
4430 append( sb, "locale", 2 );
4431 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
4432 append( sb, "Expression: ${locale}", 3 );
4433 append( sb, "", 0 );
4434
4435 append( sb, "localRepository", 2 );
4436 append( sb, "The local repository where the artifacts are located.", 3 );
4437 append( sb, "Expression: ${localRepository}", 3 );
4438 append( sb, "", 0 );
4439
4440 append( sb, "maxmemory", 2 );
4441 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
4442 append( sb, "Expression: ${maxmemory}", 3 );
4443 append( sb, "", 0 );
4444
4445 append( sb, "minmemory", 2 );
4446 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
4447 append( sb, "Expression: ${minmemory}", 3 );
4448 append( sb, "", 0 );
4449
4450 append( sb, "name", 2 );
4451 append( sb, "The name of the Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4452 append( sb, "Expression: ${name}", 3 );
4453 append( sb, "", 0 );
4454
4455 append( sb, "nocomment (Default: false)", 2 );
4456 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
4457 append( sb, "Expression: ${nocomment}", 3 );
4458 append( sb, "", 0 );
4459
4460 append( sb, "nodeprecated (Default: false)", 2 );
4461 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
4462 append( sb, "Expression: ${nodeprecated}", 3 );
4463 append( sb, "", 0 );
4464
4465 append( sb, "nodeprecatedlist (Default: false)", 2 );
4466 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
4467 append( sb, "Expression: ${nodeprecatedlist}", 3 );
4468 append( sb, "", 0 );
4469
4470 append( sb, "nohelp (Default: false)", 2 );
4471 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
4472 append( sb, "Expression: ${nohelp}", 3 );
4473 append( sb, "", 0 );
4474
4475 append( sb, "noindex (Default: false)", 2 );
4476 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
4477 append( sb, "Expression: ${noindex}", 3 );
4478 append( sb, "", 0 );
4479
4480 append( sb, "nonavbar (Default: false)", 2 );
4481 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
4482 append( sb, "Expression: ${nonavbar}", 3 );
4483 append( sb, "", 0 );
4484
4485 append( sb, "nooverview (Default: false)", 2 );
4486 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
4487 append( sb, "Expression: ${nooverview}", 3 );
4488 append( sb, "", 0 );
4489
4490 append( sb, "noqualifier", 2 );
4491 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
4492 append( sb, "Expression: ${noqualifier}", 3 );
4493 append( sb, "", 0 );
4494
4495 append( sb, "nosince (Default: false)", 2 );
4496 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
4497 append( sb, "Expression: ${nosince}", 3 );
4498 append( sb, "", 0 );
4499
4500 append( sb, "notimestamp (Default: false)", 2 );
4501 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
4502 append( sb, "Expression: ${notimestamp}", 3 );
4503 append( sb, "", 0 );
4504
4505 append( sb, "notree (Default: false)", 2 );
4506 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
4507 append( sb, "Expression: ${notree}", 3 );
4508 append( sb, "", 0 );
4509
4510 append( sb, "offlineLinks", 2 );
4511 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
4512 append( sb, "Expression: ${offlineLinks}", 3 );
4513 append( sb, "", 0 );
4514
4515 append( sb, "old (Default: false)", 2 );
4516 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
4517 append( sb, "Expression: ${old}", 3 );
4518 append( sb, "", 0 );
4519
4520 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
4521 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
4522 append( sb, "Required: Yes", 3 );
4523 append( sb, "Expression: ${destDir}", 3 );
4524 append( sb, "", 0 );
4525
4526 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
4527 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
4528 append( sb, "Expression: ${overview}", 3 );
4529 append( sb, "", 0 );
4530
4531 append( sb, "packagesheader", 2 );
4532 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
4533 append( sb, "Expression: ${packagesheader}", 3 );
4534 append( sb, "", 0 );
4535
4536 append( sb, "proxyHost", 2 );
4537 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
4538 append( sb, "", 0 );
4539 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
4540 append( sb, "Expression: ${proxyHost}", 3 );
4541 append( sb, "", 0 );
4542
4543 append( sb, "proxyPort", 2 );
4544 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
4545 append( sb, "", 0 );
4546 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
4547 append( sb, "Expression: ${proxyPort}", 3 );
4548 append( sb, "", 0 );
4549
4550 append( sb, "quiet (Default: false)", 2 );
4551 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
4552 append( sb, "Expression: ${quiet}", 3 );
4553 append( sb, "", 0 );
4554
4555 append( sb, "remoteRepositories", 2 );
4556 append( sb, "The remote repositories where artifacts are located.", 3 );
4557 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
4558 append( sb, "", 0 );
4559
4560 append( sb, "reportOutputDirectory (Default: ${project.reporting.outputDirectory}/testapidocs)", 2 );
4561 append( sb, "Specifies the destination directory where test Javadoc saves the generated HTML files.", 3 );
4562 append( sb, "Required: Yes", 3 );
4563 append( sb, "Expression: ${reportTestOutputDirectory}", 3 );
4564 append( sb, "", 0 );
4565
4566 append( sb, "resourcesArtifacts", 2 );
4567 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
4568 append( sb, "Expression: ${resourcesArtifacts}", 3 );
4569 append( sb, "", 0 );
4570
4571 append( sb, "serialwarn (Default: false)", 2 );
4572 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
4573 append( sb, "Expression: ${serialwarn}", 3 );
4574 append( sb, "", 0 );
4575
4576 append( sb, "show (Default: protected)", 2 );
4577 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
4578 append( sb, "Expression: ${show}", 3 );
4579 append( sb, "", 0 );
4580
4581 append( sb, "skip (Default: false)", 2 );
4582 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
4583 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
4584 append( sb, "", 0 );
4585
4586 append( sb, "source", 2 );
4587 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
4588 append( sb, "Expression: ${source}", 3 );
4589 append( sb, "", 0 );
4590
4591 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
4592 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
4593 append( sb, "", 0 );
4594
4595 append( sb, "sourcepath", 2 );
4596 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
4597 append( sb, "Expression: ${sourcepath}", 3 );
4598 append( sb, "", 0 );
4599
4600 append( sb, "sourcetab", 2 );
4601 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
4602 append( sb, "Expression: ${sourcetab}", 3 );
4603 append( sb, "", 0 );
4604
4605 append( sb, "splitindex (Default: false)", 2 );
4606 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
4607 append( sb, "Expression: ${splitindex}", 3 );
4608 append( sb, "", 0 );
4609
4610 append( sb, "stylesheet (Default: java)", 2 );
4611 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
4612 append( sb, "Expression: ${stylesheet}", 3 );
4613 append( sb, "", 0 );
4614
4615 append( sb, "stylesheetfile", 2 );
4616 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
4617 append( sb, "Expression: ${stylesheetfile}", 3 );
4618 append( sb, "", 0 );
4619
4620 append( sb, "subpackages", 2 );
4621 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
4622 append( sb, "Expression: ${subpackages}", 3 );
4623 append( sb, "", 0 );
4624
4625 append( sb, "taglet", 2 );
4626 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
4627 append( sb, "Expression: ${taglet}", 3 );
4628 append( sb, "", 0 );
4629
4630 append( sb, "tagletArtifact", 2 );
4631 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
4632 append( sb, "Expression: ${tagletArtifact}", 3 );
4633 append( sb, "", 0 );
4634
4635 append( sb, "tagletArtifacts", 2 );
4636 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
4637 append( sb, "Expression: ${tagletArtifacts}", 3 );
4638 append( sb, "", 0 );
4639
4640 append( sb, "tagletpath", 2 );
4641 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
4642 append( sb, "Expression: ${tagletpath}", 3 );
4643 append( sb, "", 0 );
4644
4645 append( sb, "taglets", 2 );
4646 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
4647 append( sb, "Expression: ${taglets}", 3 );
4648 append( sb, "", 0 );
4649
4650 append( sb, "tags", 2 );
4651 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
4652 append( sb, "Expression: ${tags}", 3 );
4653 append( sb, "", 0 );
4654
4655 append( sb, "testDescription", 2 );
4656 append( sb, "The description of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4657 append( sb, "Expression: ${testDescription}", 3 );
4658 append( sb, "", 0 );
4659
4660 append( sb, "testDoctitle (Default: ${project.name} ${project.version} Test API)", 2 );
4661 append( sb, "Specifies the Test title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4662 append( sb, "Expression: ${testDoctitle}", 3 );
4663 append( sb, "", 0 );
4664
4665 append( sb, "testJavadocDirectory", 2 );
4666 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
4667 append( sb, "Expression: ${basedir}/src/test/javadoc", 3 );
4668 append( sb, "", 0 );
4669
4670 append( sb, "testName", 2 );
4671 append( sb, "The name of the Test Javadoc report to be displayed in the Maven Generated Reports page (i.e. project-reports.html).", 3 );
4672 append( sb, "Expression: ${testName}", 3 );
4673 append( sb, "", 0 );
4674
4675 append( sb, "testOverview (Default: ${basedir}/src/test/javadoc/overview.html)", 2 );
4676 append( sb, "Specifies that Javadoc should retrieve the text for the Test overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
4677 append( sb, "Expression: ${testOverview}", 3 );
4678 append( sb, "", 0 );
4679
4680 append( sb, "testWindowtitle (Default: ${project.name} ${project.version} Test API)", 2 );
4681 append( sb, "Specifies the Test title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4682 append( sb, "Expression: ${testWindowtitle}", 3 );
4683 append( sb, "", 0 );
4684
4685 append( sb, "top", 2 );
4686 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
4687 append( sb, "Expression: ${top}", 3 );
4688 append( sb, "", 0 );
4689
4690 append( sb, "use (Default: true)", 2 );
4691 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
4692 append( sb, "Expression: ${use}", 3 );
4693 append( sb, "", 0 );
4694
4695 append( sb, "useStandardDocletOptions (Default: true)", 2 );
4696 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
4697 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
4698 append( sb, "", 0 );
4699
4700 append( sb, "validateLinks (Default: false)", 2 );
4701 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
4702 append( sb, "Expression: ${validateLinks}", 3 );
4703 append( sb, "", 0 );
4704
4705 append( sb, "verbose (Default: false)", 2 );
4706 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
4707 append( sb, "Expression: ${verbose}", 3 );
4708 append( sb, "", 0 );
4709
4710 append( sb, "version (Default: true)", 2 );
4711 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
4712 append( sb, "Expression: ${version}", 3 );
4713 append( sb, "", 0 );
4714
4715 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
4716 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
4717 append( sb, "Expression: ${windowtitle}", 3 );
4718 append( sb, "", 0 );
4719 }
4720 }
4721
4722 if ( goal == null || goal.length() <= 0 || "test-resource-bundle".equals( goal ) )
4723 {
4724 append( sb, "javadoc:test-resource-bundle", 0 );
4725 append( sb, "Bundle TestJavadocJar.testJavadocDirectory, along with javadoc configuration options from AbstractJavadocMojo such as taglet, doclet, and link information into a deployable artifact. This artifact can then be consumed by the javadoc plugin mojos when used by the includeDependencySources option, to generate javadocs that are somewhat consistent with those generated in the original project itself.", 1 );
4726 append( sb, "", 0 );
4727 if ( detail )
4728 {
4729 append( sb, "Available parameters:", 1 );
4730 append( sb, "", 0 );
4731
4732 append( sb, "additionalJOption", 2 );
4733 append( sb, "Set an additional Javadoc option(s) (i.e. JVM options) on the command line. Example:\n<additionalJOption>-J-Xss128m</additionalJOption>\nSee Jflag.\nSee vmoptions.\nSee Networking Properties.", 3 );
4734 append( sb, "Expression: ${additionalJOption}", 3 );
4735 append( sb, "", 0 );
4736
4737 append( sb, "additionalparam", 2 );
4738 append( sb, "Set an additional parameter(s) on the command line. This value should include quotes as necessary for parameters that include spaces. Useful for a custom doclet.", 3 );
4739 append( sb, "Expression: ${additionalparam}", 3 );
4740 append( sb, "", 0 );
4741
4742 append( sb, "aggregate (Default: false)", 2 );
4743 append( sb, "Deprecated. since 2.5. Use the goals javadoc:aggregate and javadoc:test-aggregate instead.", 3 );
4744 append( sb, "", 0 );
4745 append( sb, "Whether to build an aggregated report at the root, or build individual reports.", 3 );
4746 append( sb, "Expression: ${aggregate}", 3 );
4747 append( sb, "", 0 );
4748
4749 append( sb, "author (Default: true)", 2 );
4750 append( sb, "Specifies whether or not the author text is included in the generated Javadocs.\nSee author.\n", 3 );
4751 append( sb, "Expression: ${author}", 3 );
4752 append( sb, "", 0 );
4753
4754 append( sb, "bootclasspath", 2 );
4755 append( sb, "Specifies the paths where the boot classes reside. The bootclasspath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee bootclasspath.\n", 3 );
4756 append( sb, "Expression: ${bootclasspath}", 3 );
4757 append( sb, "", 0 );
4758
4759 append( sb, "bootclasspathArtifacts", 2 );
4760 append( sb, "Specifies the artifacts where the boot classes reside.\nSee bootclasspath.\nExample:\n<bootclasspathArtifacts>\n\u00a0\u00a0<bootclasspathArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>my-groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>my-artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>my-version</version>\n\u00a0\u00a0</bootclasspathArtifact>\n</bootclasspathArtifacts>\n\nSee Javadoc.\n", 3 );
4761 append( sb, "Expression: ${bootclasspathArtifacts}", 3 );
4762 append( sb, "", 0 );
4763
4764 append( sb, "bottom (Default: Copyright © {inceptionYear}-{currentYear} {organizationName}. All Rights Reserved.)", 2 );
4765 append( sb, "Specifies the text to be placed at the bottom of each output file.\nIf you want to use html you have to put it in a CDATA section,\neg. <![CDATA[Copyright 2005, <a href=\'http://www.mycompany.com\'>MyCompany, Inc.<a>]]>\nSee bottom.\n", 3 );
4766 append( sb, "Expression: ${bottom}", 3 );
4767 append( sb, "", 0 );
4768
4769 append( sb, "breakiterator (Default: false)", 2 );
4770 append( sb, "Uses the sentence break iterator to determine the end of the first sentence.\nSee breakiterator.\nSince Java 1.4.\n", 3 );
4771 append( sb, "Expression: ${breakiterator}", 3 );
4772 append( sb, "", 0 );
4773
4774 append( sb, "charset", 2 );
4775 append( sb, "Specifies the HTML character set for this document. If not specificed, the charset value will be the value of the docencoding parameter.\nSee charset.\n", 3 );
4776 append( sb, "Expression: ${charset}", 3 );
4777 append( sb, "", 0 );
4778
4779 append( sb, "debug (Default: false)", 2 );
4780 append( sb, "Set this to true to debug the Javadoc plugin. With this, javadoc.bat(or.sh), options, @packages or argfile files are provided in the output directory.\n", 3 );
4781 append( sb, "Expression: ${debug}", 3 );
4782 append( sb, "", 0 );
4783
4784 append( sb, "dependencySourceExcludes", 2 );
4785 append( sb, "List of excluded dependency-source patterns. Example: org.apache.maven.shared:*", 3 );
4786 append( sb, "", 0 );
4787
4788 append( sb, "dependencySourceIncludes", 2 );
4789 append( sb, "List of included dependency-source patterns. Example: org.apache.maven:*", 3 );
4790 append( sb, "", 0 );
4791
4792 append( sb, "detectJavaApiLink (Default: true)", 2 );
4793 append( sb, "Detect the Java API link for the current build, i.e. http://download.oracle.com/javase/1.4.2/docs/api/ for Java source 1.4.\nBy default, the goal detects the Javadoc API link depending the value of the source parameter in the org.apache.maven.plugins:maven-compiler-plugin (defined in ${project.build.plugins} or in ${project.build.pluginManagement}), or try to compute it from the javadocExecutable version.\nSee Javadoc for the default values.\n", 3 );
4794 append( sb, "Expression: ${detectJavaApiLink}", 3 );
4795 append( sb, "", 0 );
4796
4797 append( sb, "detectLinks (Default: false)", 2 );
4798 append( sb, "Detect the Javadoc links for all dependencies defined in the project. The detection is based on the default Maven conventions, i.e.: ${project.url}/apidocs.\nFor instance, if the project has a dependency to Apache Commons Lang i.e.:\n<dependency>\n\u00a0\u00a0<groupId>commons-lang</groupId>\n\u00a0\u00a0<artifactId>commons-lang</artifactId>\n</dependency>\nThe added Javadoc -link parameter will be http://commons.apache.org/lang/apidocs.", 3 );
4799 append( sb, "Expression: ${detectLinks}", 3 );
4800 append( sb, "", 0 );
4801
4802 append( sb, "detectOfflineLinks (Default: true)", 2 );
4803 append( sb, "Detect the links for all modules defined in the project.\nIf reactorProjects is defined in a non-aggregator way, it generates default offline links between modules based on the defined project\'s urls. For instance, if a parent project has two projects module1 and module2, the -linkoffline will be:\nThe added Javadoc -linkoffline parameter for module1 will be /absolute/path/to/module2/target/site/apidocs\nThe added Javadoc -linkoffline parameter for module2 will be /absolute/path/to/module1/target/site/apidocs", 3 );
4804 append( sb, "Expression: ${detectOfflineLinks}", 3 );
4805 append( sb, "", 0 );
4806
4807 append( sb, "docencoding (Default: ${project.reporting.outputEncoding})", 2 );
4808 append( sb, "Specifies the encoding of the generated HTML files. If not specificed, the docencoding value will be UTF-8.\nSee docencoding.", 3 );
4809 append( sb, "Expression: ${docencoding}", 3 );
4810 append( sb, "", 0 );
4811
4812 append( sb, "docfilessubdirs (Default: false)", 2 );
4813 append( sb, "Enables deep copying of the **/doc-files directories and the specifc resources directory from the javadocDirectory directory (for instance, src/main/javadoc/com/mycompany/myapp/doc-files and src/main/javadoc/resources).\nSee docfilessubdirs.\nSince Java 1.4.\nSee javadocDirectory.\n", 3 );
4814 append( sb, "Expression: ${docfilessubdirs}", 3 );
4815 append( sb, "", 0 );
4816
4817 append( sb, "doclet", 2 );
4818 append( sb, "Specifies the class file that starts the doclet used in generating the documentation.\nSee doclet.", 3 );
4819 append( sb, "Expression: ${doclet}", 3 );
4820 append( sb, "", 0 );
4821
4822 append( sb, "docletArtifact", 2 );
4823 append( sb, "Specifies the artifact containing the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifact>\n\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0<version>1.2b2</version>\n</docletArtifact>\n\nSee Javadoc.\n", 3 );
4824 append( sb, "Expression: ${docletArtifact}", 3 );
4825 append( sb, "", 0 );
4826
4827 append( sb, "docletArtifacts", 2 );
4828 append( sb, "Specifies multiple artifacts containing the path for the doclet starting class file (specified with the -doclet option).\nSee docletpath.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n\nSee Javadoc.\n", 3 );
4829 append( sb, "Expression: ${docletArtifacts}", 3 );
4830 append( sb, "", 0 );
4831
4832 append( sb, "docletPath", 2 );
4833 append( sb, "Specifies the path to the doclet starting class file (specified with the -doclet option) and any jar files it depends on. The docletPath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee docletpath.", 3 );
4834 append( sb, "Expression: ${docletPath}", 3 );
4835 append( sb, "", 0 );
4836
4837 append( sb, "doctitle (Default: ${project.name} ${project.version} API)", 2 );
4838 append( sb, "Specifies the title to be placed near the top of the overview summary file.\nSee doctitle.\n", 3 );
4839 append( sb, "Expression: ${doctitle}", 3 );
4840 append( sb, "", 0 );
4841
4842 append( sb, "encoding (Default: ${project.build.sourceEncoding})", 2 );
4843 append( sb, "Specifies the encoding name of the source files. If not specificed, the encoding value will be the value of the file.encoding system property.\nSee encoding.\nNote: In 2.4, the default value was locked to ISO-8859-1 to ensure reproducing build, but this was reverted in 2.5.\n", 3 );
4844 append( sb, "Expression: ${encoding}", 3 );
4845 append( sb, "", 0 );
4846
4847 append( sb, "excludedocfilessubdir", 2 );
4848 append( sb, "Excludes any \'doc-files\' subdirectories with the given names. Multiple patterns can be excluded by separating them with colons (:).\nSee excludedocfilessubdir.\nSince Java 1.4.", 3 );
4849 append( sb, "Expression: ${excludedocfilessubdir}", 3 );
4850 append( sb, "", 0 );
4851
4852 append( sb, "excludePackageNames", 2 );
4853 append( sb, "Unconditionally excludes the specified packages and their subpackages from the list formed by -subpackages. Multiple packages can be separated by commas (,), colons (:) or semicolons (;).\nExample:\n<excludePackageNames>*.internal:org.acme.exclude1.*:org.acme.exclude2</excludePackageNames>\n\nSee exclude.\nSince Java 1.4.", 3 );
4854 append( sb, "Expression: ${excludePackageNames}", 3 );
4855 append( sb, "", 0 );
4856
4857 append( sb, "extdirs", 2 );
4858 append( sb, "Specifies the directories where extension classes reside. Separate directories in extdirs with a colon (:) or a semi-colon (;).\nSee extdirs.", 3 );
4859 append( sb, "Expression: ${extdirs}", 3 );
4860 append( sb, "", 0 );
4861
4862 append( sb, "failOnError (Default: true)", 2 );
4863 append( sb, "Specifies if the build will fail if there are errors during javadoc execution or not.", 3 );
4864 append( sb, "Expression: ${maven.javadoc.failOnError}", 3 );
4865 append( sb, "", 0 );
4866
4867 append( sb, "footer", 2 );
4868 append( sb, "Specifies the footer text to be placed at the bottom of each output file.\nSee footer.", 3 );
4869 append( sb, "Expression: ${footer}", 3 );
4870 append( sb, "", 0 );
4871
4872 append( sb, "groups", 2 );
4873 append( sb, "Separates packages on the overview page into whatever groups you specify, one group per table. The packages pattern can be any package name, or can be the start of any package name followed by an asterisk (*) meaning \'match any characters\'. Multiple patterns can be included in a group by separating them with colons (:).\nExample:\n<groups>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Core\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0includes\u00a0java.lang,\u00a0java.lang.ref,\n\u00a0\u00a0\u00a0\u00a0java.lang.reflect\u00a0and\u00a0only\u00a0java.util\n\u00a0\u00a0\u00a0\u00a0(i.e.\u00a0not\u00a0java.util.jar)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>java.lang*:java.util</packages>\n\u00a0\u00a0</group>\n\u00a0\u00a0<group>\n\u00a0\u00a0\u00a0\u00a0<title>Extension\u00a0Packages</title>\n\u00a0\u00a0\u00a0\u00a0\u00a0<!--\u00a0To\u00a0include\u00a0javax.accessibility,\n\u00a0\u00a0\u00a0\u00a0javax.crypto,\u00a0...\u00a0(among\u00a0others)\u00a0-->\n\u00a0\u00a0\u00a0\u00a0<packages>javax.*</packages>\n\u00a0\u00a0</group>\n</groups>\nNote: using java.lang.* for packages would omit the java.lang package but using java.lang* will include it.\nSee group.\nSee Javadoc.\n", 3 );
4874 append( sb, "Expression: ${groups}", 3 );
4875 append( sb, "", 0 );
4876
4877 append( sb, "header", 2 );
4878 append( sb, "Specifies the header text to be placed at the top of each output file.\nSee header.", 3 );
4879 append( sb, "Expression: ${header}", 3 );
4880 append( sb, "", 0 );
4881
4882 append( sb, "helpfile", 2 );
4883 append( sb, "Specifies the path of an alternate help file path\\filename that the HELP link in the top and bottom navigation bars link to.\nNote: could be in conflict with <nohelp/>.\nThe helpfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\nWhere path/to/your/resource/yourhelp-doc.html could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<helpfile>path/to/your/resource/yourhelp-doc.html</helpfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourhelp-doc.html is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee helpfile.", 3 );
4884 append( sb, "Expression: ${helpfile}", 3 );
4885 append( sb, "", 0 );
4886
4887 append( sb, "includeDependencySources (Default: false)", 2 );
4888 append( sb, "Whether dependency -sources jars should be resolved and included as source paths for javadoc generation. This is useful when creating javadocs for a distribution project.", 3 );
4889 append( sb, "", 0 );
4890
4891 append( sb, "includeTransitiveDependencySources (Default: false)", 2 );
4892 append( sb, "Whether to include transitive dependencies in the list of dependency -sources jars to include in this javadoc run.", 3 );
4893 append( sb, "", 0 );
4894
4895 append( sb, "javaApiLinks", 2 );
4896 append( sb, "Use this parameter only if the Sun Javadoc API urls have been changed or to use custom urls for Javadoc API url.\nSee Javadoc for the default values.\n", 3 );
4897 append( sb, "Expression: ${javaApiLinks}", 3 );
4898 append( sb, "", 0 );
4899
4900 append( sb, "javadocDirectory", 2 );
4901 append( sb, "Specifies the Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).\nCould be used in addition of docfilessubdirs parameter.\nSee docfilessubdirs.", 3 );
4902 append( sb, "Expression: ${basedir}/src/main/javadoc", 3 );
4903 append( sb, "", 0 );
4904
4905 append( sb, "javadocExecutable", 2 );
4906 append( sb, "Sets the absolute path of the Javadoc Tool executable to use. Since version 2.5, a mere directory specification is sufficient to have the plugin use \'javadoc\' or \'javadoc.exe\' respectively from this directory.", 3 );
4907 append( sb, "Expression: ${javadocExecutable}", 3 );
4908 append( sb, "", 0 );
4909
4910 append( sb, "javadocVersion", 2 );
4911 append( sb, "Version of the Javadoc Tool executable to use, ex. \'1.3\', \'1.5\'.", 3 );
4912 append( sb, "Expression: ${javadocVersion}", 3 );
4913 append( sb, "", 0 );
4914
4915 append( sb, "keywords (Default: false)", 2 );
4916 append( sb, "Adds HTML meta keyword tags to the generated file for each class.\nSee keywords.\nSince Java 1.4.2.\nSince Java 5.0.\n", 3 );
4917 append( sb, "Expression: ${keywords}", 3 );
4918 append( sb, "", 0 );
4919
4920 append( sb, "links", 2 );
4921 append( sb, "Creates links to existing javadoc-generated documentation of external referenced classes.\nNotes:\n1.\tonly used if isOffline is set to false.\n2.\tall given links should have a fetchable /package-list file. For instance:\n\t<links>\n\u00a0\u00a0<link>http://download.oracle.com/javase/1.4.2/docs/api</link>\n<links>\n\twill be used because http://download.oracle.com/javase/1.4.2/docs/api/package-list exists.\n3.\tif detectLinks is defined, the links between the project dependencies are automatically added.\n4.\tif detectJavaApiLink is defined, a Java API link, based on the Java version of the project\'s sources, will be added automatically.\nSee link.", 3 );
4922 append( sb, "Expression: ${links}", 3 );
4923 append( sb, "", 0 );
4924
4925 append( sb, "linksource (Default: false)", 2 );
4926 append( sb, "Creates an HTML version of each source file (with line numbers) and adds links to them from the standard HTML documentation.\nSee linksource.\nSince Java 1.4.\n", 3 );
4927 append( sb, "Expression: ${linksource}", 3 );
4928 append( sb, "", 0 );
4929
4930 append( sb, "locale", 2 );
4931 append( sb, "Specifies the locale that javadoc uses when generating documentation.\nSee locale.", 3 );
4932 append( sb, "Expression: ${locale}", 3 );
4933 append( sb, "", 0 );
4934
4935 append( sb, "localRepository", 2 );
4936 append( sb, "The local repository where the artifacts are located.", 3 );
4937 append( sb, "Expression: ${localRepository}", 3 );
4938 append( sb, "", 0 );
4939
4940 append( sb, "maxmemory", 2 );
4941 append( sb, "Specifies the maximum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xmx parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
4942 append( sb, "Expression: ${maxmemory}", 3 );
4943 append( sb, "", 0 );
4944
4945 append( sb, "minmemory", 2 );
4946 append( sb, "Specifies the minimum Java heap size to be used when launching the Javadoc tool. JVMs refer to this property as the -Xms parameter. Example: \'512\' or \'512m\'. The memory unit depends on the JVM used. The units supported could be: k, kb, m, mb, g, gb, t, tb. If no unit specified, the default unit is m.", 3 );
4947 append( sb, "Expression: ${minmemory}", 3 );
4948 append( sb, "", 0 );
4949
4950 append( sb, "nocomment (Default: false)", 2 );
4951 append( sb, "Suppress the entire comment body, including the main description and all tags, generating only declarations.\nSee nocomment.\nSince Java 1.4.\n", 3 );
4952 append( sb, "Expression: ${nocomment}", 3 );
4953 append( sb, "", 0 );
4954
4955 append( sb, "nodeprecated (Default: false)", 2 );
4956 append( sb, "Prevents the generation of any deprecated API at all in the documentation.\nSee nodeprecated.\n", 3 );
4957 append( sb, "Expression: ${nodeprecated}", 3 );
4958 append( sb, "", 0 );
4959
4960 append( sb, "nodeprecatedlist (Default: false)", 2 );
4961 append( sb, "Prevents the generation of the file containing the list of deprecated APIs (deprecated-list.html) and the link in the navigation bar to that page.\nSee nodeprecatedlist.\n", 3 );
4962 append( sb, "Expression: ${nodeprecatedlist}", 3 );
4963 append( sb, "", 0 );
4964
4965 append( sb, "nohelp (Default: false)", 2 );
4966 append( sb, "Omits the HELP link in the navigation bars at the top and bottom of each page of output.\nNote: could be in conflict with <helpfile/>.\nSee nohelp.\n", 3 );
4967 append( sb, "Expression: ${nohelp}", 3 );
4968 append( sb, "", 0 );
4969
4970 append( sb, "noindex (Default: false)", 2 );
4971 append( sb, "Omits the index from the generated docs.\nNote: could be in conflict with <splitindex/>.\nSee noindex.\n", 3 );
4972 append( sb, "Expression: ${noindex}", 3 );
4973 append( sb, "", 0 );
4974
4975 append( sb, "nonavbar (Default: false)", 2 );
4976 append( sb, "Omits the navigation bar from the generated docs.\nSee nonavbar.\n", 3 );
4977 append( sb, "Expression: ${nonavbar}", 3 );
4978 append( sb, "", 0 );
4979
4980 append( sb, "nooverview (Default: false)", 2 );
4981 append( sb, "Omits the entire overview page from the generated docs.\nNote: could be in conflict with <overview/>.\nStandard Doclet undocumented option.\n", 3 );
4982 append( sb, "Expression: ${nooverview}", 3 );
4983 append( sb, "", 0 );
4984
4985 append( sb, "noqualifier", 2 );
4986 append( sb, "Omits qualifying package name from ahead of class names in output. Example:\n<noqualifier>all</noqualifier>\nor\n<noqualifier>packagename1:packagename2</noqualifier>\nSee noqualifier.\nSince Java 1.4.", 3 );
4987 append( sb, "Expression: ${noqualifier}", 3 );
4988 append( sb, "", 0 );
4989
4990 append( sb, "nosince (Default: false)", 2 );
4991 append( sb, "Omits from the generated docs the \'Since\' sections associated with the since tags.\nSee nosince.\n", 3 );
4992 append( sb, "Expression: ${nosince}", 3 );
4993 append( sb, "", 0 );
4994
4995 append( sb, "notimestamp (Default: false)", 2 );
4996 append( sb, "Suppresses the timestamp, which is hidden in an HTML comment in the generated HTML near the top of each page.\nSee notimestamp.\nSince Java 5.0.\n", 3 );
4997 append( sb, "Expression: ${notimestamp}", 3 );
4998 append( sb, "", 0 );
4999
5000 append( sb, "notree (Default: false)", 2 );
5001 append( sb, "Omits the class/interface hierarchy pages from the generated docs.\nSee notree.\n", 3 );
5002 append( sb, "Expression: ${notree}", 3 );
5003 append( sb, "", 0 );
5004
5005 append( sb, "offlineLinks", 2 );
5006 append( sb, "This option is a variation of -link; they both create links to javadoc-generated documentation for external referenced classes.\nSee linkoffline.\nExample:\n<offlineLinks>\n\u00a0\u00a0<offlineLink>\n\u00a0\u00a0\u00a0\u00a0<url>http://download.oracle.com/javase/1.5.0/docs/api/</url>\n\u00a0\u00a0\u00a0\u00a0<location>../javadoc/jdk-5.0/</location>\n\u00a0\u00a0</offlineLink>\n</offlineLinks>\n\nNote: if detectOfflineLinks is defined, the offline links between the project modules are automatically added if the goal is calling in a non-aggregator way.\nSee Javadoc.\n", 3 );
5007 append( sb, "Expression: ${offlineLinks}", 3 );
5008 append( sb, "", 0 );
5009
5010 append( sb, "old (Default: false)", 2 );
5011 append( sb, "This option creates documentation with the appearance and functionality of documentation generated by Javadoc 1.1.\nSee 1.1.\n", 3 );
5012 append( sb, "Expression: ${old}", 3 );
5013 append( sb, "", 0 );
5014
5015 append( sb, "outputDirectory (Default: ${project.build.directory}/apidocs)", 2 );
5016 append( sb, "Specifies the destination directory where javadoc saves the generated HTML files.\nSee d.\n", 3 );
5017 append( sb, "Required: Yes", 3 );
5018 append( sb, "Expression: ${destDir}", 3 );
5019 append( sb, "", 0 );
5020
5021 append( sb, "overview (Default: ${basedir}/src/main/javadoc/overview.html)", 2 );
5022 append( sb, "Specifies that javadoc should retrieve the text for the overview documentation from the \'source\' file specified by path/filename and place it on the Overview page (overview-summary.html).\nNote: could be in conflict with <nooverview/>.\nSee overview.\n", 3 );
5023 append( sb, "Expression: ${overview}", 3 );
5024 append( sb, "", 0 );
5025
5026 append( sb, "packagesheader", 2 );
5027 append( sb, "Specify the text for upper left frame.\nSince Java 1.4.2.", 3 );
5028 append( sb, "Expression: ${packagesheader}", 3 );
5029 append( sb, "", 0 );
5030
5031 append( sb, "proxyHost", 2 );
5032 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy host in settings.xml.", 3 );
5033 append( sb, "", 0 );
5034 append( sb, "Specifies the proxy host where the javadoc web access in -link would pass through. It defaults to the proxy host of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
5035 append( sb, "Expression: ${proxyHost}", 3 );
5036 append( sb, "", 0 );
5037
5038 append( sb, "proxyPort", 2 );
5039 append( sb, "Deprecated. since 2.4. Instead of, configure an active proxy port in settings.xml.", 3 );
5040 append( sb, "", 0 );
5041 append( sb, "Specifies the proxy port where the javadoc web access in -link would pass through. It defaults to the proxy port of the active proxy set in the settings.xml, otherwise it gets the proxy configuration set in the pom.\n", 3 );
5042 append( sb, "Expression: ${proxyPort}", 3 );
5043 append( sb, "", 0 );
5044
5045 append( sb, "quiet (Default: false)", 2 );
5046 append( sb, "Shuts off non-error and non-warning messages, leaving only the warnings and errors appear, making them easier to view.\nNote: was a standard doclet in Java 1.4.2 (refer to bug ID 4714350).\nSee quiet.\nSince Java 5.0.\n", 3 );
5047 append( sb, "Expression: ${quiet}", 3 );
5048 append( sb, "", 0 );
5049
5050 append( sb, "remoteRepositories", 2 );
5051 append( sb, "The remote repositories where artifacts are located.", 3 );
5052 append( sb, "Expression: ${project.remoteArtifactRepositories}", 3 );
5053 append( sb, "", 0 );
5054
5055 append( sb, "resourcesArtifacts", 2 );
5056 append( sb, "A list of artifacts containing resources which should be copied into the Javadoc output directory (like stylesheets, icons, etc.).\nExample:\n<resourcesArtifacts>\n\u00a0\u00a0<resourcesArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>external.group.id</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>external-resources</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.0</version>\n\u00a0\u00a0</resourcesArtifact>\n</resourcesArtifacts>\n\nSee Javadoc.\n", 3 );
5057 append( sb, "Expression: ${resourcesArtifacts}", 3 );
5058 append( sb, "", 0 );
5059
5060 append( sb, "serialwarn (Default: false)", 2 );
5061 append( sb, "Generates compile-time warnings for missing serial tags.\nSee serialwarn\n", 3 );
5062 append( sb, "Expression: ${serialwarn}", 3 );
5063 append( sb, "", 0 );
5064
5065 append( sb, "show (Default: protected)", 2 );
5066 append( sb, "Specifies the access level for classes and members to show in the Javadocs. Possible values are:\n-\tpublic (shows only public classes and members)\n-\tprotected (shows only public and protected classes and members)\n-\tpackage (shows all classes and members not marked private)\n-\tprivate (shows all classes and members)\n\n", 3 );
5067 append( sb, "Expression: ${show}", 3 );
5068 append( sb, "", 0 );
5069
5070 append( sb, "skip (Default: false)", 2 );
5071 append( sb, "Specifies whether the Javadoc generation should be skipped.", 3 );
5072 append( sb, "Expression: ${maven.javadoc.skip}", 3 );
5073 append( sb, "", 0 );
5074
5075 append( sb, "source", 2 );
5076 append( sb, "Necessary to enable javadoc to handle assertions present in J2SE v 1.4 source code.\nSee source.\nSince Java 1.4.", 3 );
5077 append( sb, "Expression: ${source}", 3 );
5078 append( sb, "", 0 );
5079
5080 append( sb, "sourceDependencyCacheDir (Default: ${project.build.directory}/distro-javadoc-sources)", 2 );
5081 append( sb, "Directory where unpacked project sources / test-sources should be cached.", 3 );
5082 append( sb, "", 0 );
5083
5084 append( sb, "sourcepath", 2 );
5085 append( sb, "Specifies the source paths where the subpackages are located. The sourcepath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee sourcepath.", 3 );
5086 append( sb, "Expression: ${sourcepath}", 3 );
5087 append( sb, "", 0 );
5088
5089 append( sb, "sourcetab", 2 );
5090 append( sb, "Specify the number of spaces each tab takes up in the source. If no tab is used in source, the default space is used.\nNote: was linksourcetab in Java 1.4.2 (refer to bug ID 4788919).\nSince 1.4.2.\nSince Java 5.0.", 3 );
5091 append( sb, "Expression: ${sourcetab}", 3 );
5092 append( sb, "", 0 );
5093
5094 append( sb, "splitindex (Default: false)", 2 );
5095 append( sb, "Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.\nNote: could be in conflict with <noindex/>.\nSee splitindex.\n", 3 );
5096 append( sb, "Expression: ${splitindex}", 3 );
5097 append( sb, "", 0 );
5098
5099 append( sb, "stylesheet (Default: java)", 2 );
5100 append( sb, "Specifies whether the stylesheet to be used is the maven\'s javadoc stylesheet or java\'s default stylesheet when a stylesheetfile parameter is not specified.\nPossible values: maven or java.\n", 3 );
5101 append( sb, "Expression: ${stylesheet}", 3 );
5102 append( sb, "", 0 );
5103
5104 append( sb, "stylesheetfile", 2 );
5105 append( sb, "Specifies the path of an alternate HTML stylesheet file.\nThe stylesheetfile could be an absolute File path.\nSince 2.6, it could be also be a path from a resource in the current project source directories (i.e. src/main/java, src/main/resources or src/main/javadoc) or from a resource in the Javadoc plugin dependencies, for instance:\n<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\nWhere path/to/your/resource/yourstylesheet.css could be in src/main/javadoc.\n<build>\n\u00a0\u00a0<plugins>\n\u00a0\u00a0\u00a0\u00a0<plugin>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>org.apache.maven.plugins</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>maven-javadoc-plugin</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<stylesheetfile>path/to/your/resource/yourstylesheet.css</stylesheetfile>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</configuration>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependencies>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>groupId</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifactId</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version</version>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependency>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0</dependencies>\n\u00a0\u00a0\u00a0\u00a0</plugin>\n\u00a0\u00a0\u00a0\u00a0...\n\u00a0\u00a0<plugins>\n</build>\nWhere path/to/your/resource/yourstylesheet.css is defined in the groupId:artifactId:version javadoc plugin dependency.\nSee stylesheetfile.", 3 );
5106 append( sb, "Expression: ${stylesheetfile}", 3 );
5107 append( sb, "", 0 );
5108
5109 append( sb, "subpackages", 2 );
5110 append( sb, "Specifies the package directory where javadoc will be executed. Multiple packages can be separated by colons (:).\nSee subpackages.\nSince Java 1.4.", 3 );
5111 append( sb, "Expression: ${subpackages}", 3 );
5112 append( sb, "", 0 );
5113
5114 append( sb, "taglet", 2 );
5115 append( sb, "Specifies the class file that starts the taglet used in generating the documentation for that tag.\nSee taglet.\nSince Java 1.4.", 3 );
5116 append( sb, "Expression: ${taglet}", 3 );
5117 append( sb, "", 0 );
5118
5119 append( sb, "tagletArtifact", 2 );
5120 append( sb, "Specifies the Taglet artifact containing the taglet class files (.class).\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>package.to.AnotherTagletClass</tagletClass>\n\u00a0\u00a0</taglet>\n\u00a0\u00a0...\n</taglets>\n<tagletArtifact>\n\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0<version>version-Taglet</version>\n</tagletArtifact>\n\nSee Javadoc.\n", 3 );
5121 append( sb, "Expression: ${tagletArtifact}", 3 );
5122 append( sb, "", 0 );
5123
5124 append( sb, "tagletArtifacts", 2 );
5125 append( sb, "Specifies several Taglet artifacts containing the taglet class files (.class). These taglets class names will be auto-detect and so no need to specify them.\nSee taglet.\nSee tagletpath.\nExample:\n<tagletArtifacts>\n\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0...\n</tagletArtifacts>\n\nSee Javadoc.\n", 3 );
5126 append( sb, "Expression: ${tagletArtifacts}", 3 );
5127 append( sb, "", 0 );
5128
5129 append( sb, "tagletpath", 2 );
5130 append( sb, "Specifies the search paths for finding taglet class files (.class). The tagletpath can contain multiple paths by separating them with a colon (:) or a semi-colon (;).\nSee tagletpath.\nSince Java 1.4.", 3 );
5131 append( sb, "Expression: ${tagletpath}", 3 );
5132 append( sb, "", 0 );
5133
5134 append( sb, "taglets", 2 );
5135 append( sb, "Enables the Javadoc tool to interpret multiple taglets.\nSee taglet.\nSee tagletpath.\nExample:\n<taglets>\n\u00a0\u00a0<taglet>\n\u00a0\u00a0\u00a0\u00a0<tagletClass>com.sun.tools.doclets.ToDoTaglet</tagletClass>\n\u00a0\u00a0\u00a0\u00a0<!--<tagletpath>/home/taglets</tagletpath>-->\n\u00a0\u00a0\u00a0\u00a0<tagletArtifact>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<groupId>group-Taglet</groupId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<artifactId>artifact-Taglet</artifactId>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<version>version-Taglet</version>\n\u00a0\u00a0\u00a0\u00a0</tagletArtifact>\n\u00a0\u00a0</taglet>\n</taglets>\n\nSee Javadoc.\n", 3 );
5136 append( sb, "Expression: ${taglets}", 3 );
5137 append( sb, "", 0 );
5138
5139 append( sb, "tags", 2 );
5140 append( sb, "Enables the Javadoc tool to interpret a simple, one-argument custom block tag tagname in doc comments.\nSee tag.\nSince Java 1.4.\nExample:\n<tags>\n\u00a0\u00a0<tag>\n\u00a0\u00a0\u00a0\u00a0<name>todo</name>\n\u00a0\u00a0\u00a0\u00a0<placement>a</placement>\n\u00a0\u00a0\u00a0\u00a0<head>To\u00a0Do:</head>\n\u00a0\u00a0</tag>\n</tags>\nNote: the placement should be a combinaison of Xaoptcmf letters:\n-\tX (disable tag)\n-\ta (all)\n-\to (overview)\n-\tp (packages)\n-\tt (types, that is classes and interfaces)\n-\tc (constructors)\n-\tm (methods)\n-\tf (fields)\nSee Javadoc.\n", 3 );
5141 append( sb, "Expression: ${tags}", 3 );
5142 append( sb, "", 0 );
5143
5144 append( sb, "testJavadocDirectory (Default: ${basedir}/src/test/javadoc)", 2 );
5145 append( sb, "Specifies the Test Javadoc resources directory to be included in the Javadoc (i.e. package.html, images...).", 3 );
5146 append( sb, "", 0 );
5147
5148 append( sb, "top", 2 );
5149 append( sb, "Specifies the top text to be placed at the top of each output file.\nSee 6227616.\nSince Java 6.0", 3 );
5150 append( sb, "Expression: ${top}", 3 );
5151 append( sb, "", 0 );
5152
5153 append( sb, "use (Default: true)", 2 );
5154 append( sb, "Includes one \'Use\' page for each documented class and package.\nSee use.\n", 3 );
5155 append( sb, "Expression: ${use}", 3 );
5156 append( sb, "", 0 );
5157
5158 append( sb, "useStandardDocletOptions (Default: true)", 2 );
5159 append( sb, "Specifies to use the options provided by the Standard Doclet for a custom doclet.\nExample:\n<docletArtifacts>\n\u00a0\u00a0<docletArtifact>\n\u00a0\u00a0\u00a0\u00a0<groupId>com.sun.tools.doclets</groupId>\n\u00a0\u00a0\u00a0\u00a0<artifactId>doccheck</artifactId>\n\u00a0\u00a0\u00a0\u00a0<version>1.2b2</version>\n\u00a0\u00a0</docletArtifact>\n</docletArtifacts>\n<useStandardDocletOptions>true</useStandardDocletOptions>\n", 3 );
5160 append( sb, "Expression: ${useStandardDocletOptions}", 3 );
5161 append( sb, "", 0 );
5162
5163 append( sb, "validateLinks (Default: false)", 2 );
5164 append( sb, "Flag controlling content validation of package-list resources. If set, the content of package-list resources will be validated.", 3 );
5165 append( sb, "Expression: ${validateLinks}", 3 );
5166 append( sb, "", 0 );
5167
5168 append( sb, "verbose (Default: false)", 2 );
5169 append( sb, "Provides more detailed messages while javadoc is running.\nSee verbose.\n", 3 );
5170 append( sb, "Expression: ${verbose}", 3 );
5171 append( sb, "", 0 );
5172
5173 append( sb, "version (Default: true)", 2 );
5174 append( sb, "Includes the version text in the generated docs.\nSee version.\n", 3 );
5175 append( sb, "Expression: ${version}", 3 );
5176 append( sb, "", 0 );
5177
5178 append( sb, "windowtitle (Default: ${project.name} ${project.version} API)", 2 );
5179 append( sb, "Specifies the title to be placed in the HTML title tag.\nSee windowtitle.\n", 3 );
5180 append( sb, "Expression: ${windowtitle}", 3 );
5181 append( sb, "", 0 );
5182 }
5183 }
5184
5185 if ( getLog().isInfoEnabled() )
5186 {
5187 getLog().info( sb.toString() );
5188 }
5189 }
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200 private static String repeat( String str, int repeat )
5201 {
5202 StringBuffer buffer = new StringBuffer( repeat * str.length() );
5203
5204 for ( int i = 0; i < repeat; i++ )
5205 {
5206 buffer.append( str );
5207 }
5208
5209 return buffer.toString();
5210 }
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220 private void append( StringBuffer sb, String description, int indent )
5221 {
5222 for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); )
5223 {
5224 sb.append( it.next().toString() ).append( '\n' );
5225 }
5226 }
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238 private static List toLines( String text, int indent, int indentSize, int lineLength )
5239 {
5240 List lines = new ArrayList();
5241
5242 String ind = repeat( "\t", indent );
5243 String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" );
5244 for ( int i = 0; i < plainLines.length; i++ )
5245 {
5246 toLines( lines, ind + plainLines[i], indentSize, lineLength );
5247 }
5248
5249 return lines;
5250 }
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260 private static void toLines( List lines, String line, int indentSize, int lineLength )
5261 {
5262 int lineIndent = getIndentLevel( line );
5263 StringBuffer buf = new StringBuffer( 256 );
5264 String[] tokens = line.split( " +" );
5265 for ( int i = 0; i < tokens.length; i++ )
5266 {
5267 String token = tokens[i];
5268 if ( i > 0 )
5269 {
5270 if ( buf.length() + token.length() >= lineLength )
5271 {
5272 lines.add( buf.toString() );
5273 buf.setLength( 0 );
5274 buf.append( repeat( " ", lineIndent * indentSize ) );
5275 }
5276 else
5277 {
5278 buf.append( ' ' );
5279 }
5280 }
5281 for ( int j = 0; j < token.length(); j++ )
5282 {
5283 char c = token.charAt( j );
5284 if ( c == '\t' )
5285 {
5286 buf.append( repeat( " ", indentSize - buf.length() % indentSize ) );
5287 }
5288 else if ( c == '\u00A0' )
5289 {
5290 buf.append( ' ' );
5291 }
5292 else
5293 {
5294 buf.append( c );
5295 }
5296 }
5297 }
5298 lines.add( buf.toString() );
5299 }
5300
5301
5302
5303
5304
5305
5306
5307 private static int getIndentLevel( String line )
5308 {
5309 int level = 0;
5310 for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ )
5311 {
5312 level++;
5313 }
5314 for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ )
5315 {
5316 if ( line.charAt( i ) == '\t' )
5317 {
5318 level++;
5319 break;
5320 }
5321 }
5322 return level;
5323 }
5324 }