source: release-kits/lirk3/resources/gs3-release-maker/apache-ant-1.6.5/docs/manual/CoreTasks/javadoc.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 32.0 KB
Line 
1<html>
2
3<head>
4<meta http-equiv="Content-Language" content="en-us">
5<title>Javadoc Task</title>
6<link rel="stylesheet" type="text/css" href="../stylesheets/antmanual.css">
7</head>
8
9<body>
10
11<h2><a name="javadoc">Javadoc/<i>Javadoc2</i></a></h2>
12<h3>Description</h3>
13<p>Generates code documentation using the javadoc tool.</p>
14<p>The source directory will be recursively scanned for Java source files to process
15but only those matching the inclusion rules, and not matching the exclusions rules
16will be passed to the javadoc tool. This
17allows wildcards to be used to choose between package names, reducing verbosity
18and management costs over time. This task, however, has no notion of
19&quot;changed&quot; files, unlike the <a href="javac.html">javac</a> task. This means
20all packages will be processed each time this task is run. In general, however,
21this task is used much less frequently.</p>
22<p>This task works seamlessly between different javadoc versions (1.2 and 1.4),
23with the obvious restriction that the 1.4 attributes
24will be ignored if run in a 1.2 VM.</p>
25<p>NOTE: since javadoc calls System.exit(), javadoc cannot be run inside the
26same VM as Ant without breaking functionality. For this reason, this task
27always forks the VM. This overhead is not significant since javadoc is normally a heavy
28application and will be called infrequently.</p>
29<p>NOTE: the packagelist attribute allows you to specify the list of packages to
30document outside of the Ant file. It's a much better practice to include everything
31inside the <code>build.xml</code> file. This option was added in order to make it easier to
32migrate from regular makefiles, where you would use this option of javadoc.
33The packages listed in packagelist are not checked, so the task performs even
34if some packages are missing or broken. Use this option if you wish to convert from
35an existing makefile. Once things are running you should then switch to the regular
36notation. </p>
37
38<p><i><b>DEPRECATION:</b> the javadoc2 task simply points to the javadoc task and it's
39there for back compatibility reasons. Since this task will be removed in future
40versions, you are strongly encouraged to use <a href="javadoc.html">javadoc</a>
41instead.</i></p>
42
43<p>In the table below, 1.2 means available if your current Java VM is
44a 1.2 VM (but not 1.3 or later), 1.4+ for any VM of at least version 1.4, otherwise
45any VM of at least version 1.2 is acceptable. JDK 1.1 is no longer supported.
46If you specify the <code>executable</code> attribute it is up to you
47to ensure that this command supports the attributes you wish to use.</p>
48
49<h3>Parameters</h3>
50<table border="1" cellpadding="2" cellspacing="0">
51 <tr>
52 <td valign="top"><b>Attribute</b></td>
53 <td valign="top"><b>Description</b></td>
54 <td align="center" valign="top"><b>Availability</b></td>
55 <td align="center" valign="top"><b>Required</b></td>
56 </tr>
57 <tr>
58 <td valign="top">sourcepath</td>
59 <td valign="top">Specify where to find source files</td>
60 <td align="center" valign="top">all</td>
61 <td align="center" rowspan="3">At least one of the three or nested
62 <code>&lt;sourcepath&gt;</code>, <code>&lt;fileset&gt;</code> or
63 <code>&lt;packageset&gt;</code></td>
64 </tr>
65 <tr>
66 <td valign="top">sourcepathref</td>
67 <td valign="top">Specify where to find source files by <a
68 href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
69 <td align="center" valign="top">all</td>
70 </tr>
71 <tr>
72 <td valign="top">sourcefiles</td>
73 <td valign="top">Comma separated list of source files -- see also
74 the nested <code>source</code> element.</td>
75 <td align="center" valign="top">all</td>
76 </tr>
77 <tr>
78 <td valign="top">destdir</td>
79 <td valign="top">Destination directory for output files</td>
80 <td align="center" valign="top">all</td>
81 <td align="center" valign="top">Yes, unless a doclet has been specified.</td>
82 </tr>
83 <tr>
84 <td valign="top">maxmemory</td>
85 <td valign="top">Max amount of memory to allocate to the javadoc VM</td>
86 <td align="center" valign="top">all</td>
87 <td align="center" valign="top">No</td>
88 </tr>
89 <tr>
90 <td valign="top">packagenames</td>
91 <td valign="top">Comma separated list of package files (with terminating
92 wildcard) -- see also the nested <code>package</code> element.</td>
93 <td align="center" valign="top">all</td>
94 <td align="center" valign="top">No</td>
95 </tr>
96 <tr>
97 <td valign="top">packageList</td>
98 <td valign="top">The name of a file containing the packages to process</td>
99 <td align="center" valign="top">all</td>
100 <td align="center" valign="top">No</td>
101 </tr>
102 <tr>
103 <td valign="top">classpath</td>
104 <td valign="top">Specify where to find user class files</td>
105 <td align="center" valign="top">all</td>
106 <td align="center" valign="top">No</td>
107 </tr>
108 <tr>
109 <td valign="top">Bootclasspath</td>
110 <td valign="top">Override location of class files loaded by the bootstrap
111 class loader</td>
112 <td align="center" valign="top">all</td>
113 <td align="center" valign="top">No</td>
114 </tr>
115 <tr>
116 <td valign="top">classpathref</td>
117 <td valign="top">Specify where to find user class files by <a
118 href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
119 <td align="center" valign="top">all</td>
120 <td align="center" valign="top">No</td>
121 </tr>
122 <tr>
123 <td valign="top">bootclasspathref</td>
124 <td valign="top">Override location of class files loaded by the
125 bootstrap class loader by <a href="../using.html#references">reference</a> to a
126 PATH defined elsewhere.</td>
127 <td align="center" valign="top">all</td>
128 <td align="center" valign="top">No</td>
129 </tr>
130 <tr>
131 <td valign="top">Extdirs</td>
132 <td valign="top">Override location of installed extensions</td>
133 <td align="center" valign="top">all</td>
134 <td align="center" valign="top">No</td>
135 </tr>
136 <tr>
137 <td valign="top">Overview</td>
138 <td valign="top">Read overview documentation from HTML file</td>
139 <td align="center" valign="top">all</td>
140 <td align="center" valign="top">No</td>
141 </tr>
142 <tr>
143 <td valign="top">access</td>
144 <td valign="top">Access mode: one of <code>public</code>, <code>protected</code>,
145 <code>package</code>, or <code>private</code></td>
146 <td align="center" valign="top">all</td>
147 <td align="center" valign="top">No (default <code>protected</code>)</td>
148 </tr>
149 <tr>
150 <td valign="top">Public</td>
151 <td valign="top">Show only public classes and members</td>
152 <td align="center" valign="top">all</td>
153 <td align="center" valign="top">No</td>
154 </tr>
155 <tr>
156 <td valign="top">Protected</td>
157 <td valign="top">Show protected/public classes and members (default)</td>
158 <td align="center" valign="top">all</td>
159 <td align="center" valign="top">No</td>
160 </tr>
161 <tr>
162 <td valign="top">Package</td>
163 <td valign="top">Show package/protected/public classes and members</td>
164 <td align="center" valign="top">all</td>
165 <td align="center" valign="top">No</td>
166 </tr>
167 <tr>
168 <td valign="top">Private</td>
169 <td valign="top">Show all classes and members</td>
170 <td align="center" valign="top">all</td>
171 <td align="center" valign="top">No</td>
172 </tr>
173 <tr>
174 <td valign="top">Old</td>
175 <td valign="top">Generate output using JDK 1.1 emulating doclet</td>
176 <td align="center" valign="top">1.2</td>
177 <td align="center" valign="top">No</td>
178 </tr>
179 <tr>
180 <td valign="top">Verbose</td>
181 <td valign="top">Output messages about what Javadoc is doing</td>
182 <td align="center" valign="top">all</td>
183 <td align="center" valign="top">No</td>
184 </tr>
185 <tr>
186 <td valign="top">Locale</td>
187 <td valign="top">Locale to be used, e.g. en_US or en_US_WIN</td>
188 <td align="center" valign="top">all</td>
189 <td align="center" valign="top">No</td>
190 </tr>
191 <tr>
192 <td valign="top">Encoding</td>
193 <td valign="top">Source file encoding name</td>
194 <td align="center" valign="top">all</td>
195 <td align="center" valign="top">No</td>
196 </tr>
197 <tr>
198 <td valign="top">Version</td>
199 <td valign="top">Include @version paragraphs</td>
200 <td align="center" valign="top">all</td>
201 <td align="center" valign="top">No</td>
202 </tr>
203 <tr>
204 <td valign="top">Use</td>
205 <td valign="top">Create class and package usage pages</td>
206 <td align="center" valign="top">all</td>
207 <td align="center" valign="top">No</td>
208 </tr>
209 <tr>
210 <td valign="top">Author</td>
211 <td valign="top">Include @author paragraphs</td>
212 <td align="center" valign="top">all</td>
213 <td align="center" valign="top">No</td>
214 </tr>
215 <tr>
216 <td valign="top">Splitindex</td>
217 <td valign="top">Split index into one file per letter</td>
218 <td align="center" valign="top">all</td>
219 <td align="center" valign="top">No</td>
220 </tr>
221 <tr>
222 <td valign="top">Windowtitle</td>
223 <td valign="top">Browser window title for the documentation (text)</td>
224 <td align="center" valign="top">all</td>
225 <td align="center" valign="top">No</td>
226 </tr>
227 <tr>
228 <td valign="top">Doctitle</td>
229 <td valign="top">Include title for the package index(first) page (html-code)</td>
230 <td align="center" valign="top">all</td>
231 <td align="center" valign="top">No</td>
232 </tr>
233 <tr>
234 <td valign="top">Header</td>
235 <td valign="top">Include header text for each page (html-code)</td>
236 <td align="center" valign="top">all</td>
237 <td align="center" valign="top">No</td>
238 </tr>
239 <tr>
240 <td valign="top">Footer</td>
241 <td valign="top">Include footer text for each page (html-code)</td>
242 <td align="center" valign="top">all</td>
243 <td align="center" valign="top">No</td>
244 </tr>
245 <tr>
246 <td valign="top">bottom</td>
247 <td valign="top">Include bottom text for each page (html-code)</td>
248 <td align="center" valign="top">all</td>
249 <td align="center" valign="top">No</td>
250 </tr>
251 <tr>
252 <td valign="top">link</td>
253 <td valign="top">Create links to javadoc output at the given URL
254 -- see also the nested <code>link</code> element.</td>
255 <td align="center" valign="top">all</td>
256 <td align="center" valign="top">No</td>
257 </tr>
258 <tr>
259 <td valign="top">linkoffline</td>
260 <td valign="top">Link to docs at <code>&lt;url&gt;</code> using package list at
261 <code>&lt;url2&gt;</code> - separate the URLs by using a space character -- see
262 also the nested <code>link</code> element.</td>
263 <td align="center" valign="top">all</td>
264 <td align="center" valign="top">No</td>
265 </tr>
266 <tr>
267 <td valign="top">group</td>
268 <td valign="top">Group specified packages together in overview
269 page. The format is as described <a
270 href="#groupattribute">below</a> -- see also the nested
271 <code>group</code> element.</td>
272 <td align="center" valign="top">all</td>
273 <td align="center" valign="top">No</td>
274 </tr>
275 <tr>
276 <td valign="top">nodeprecated</td>
277 <td valign="top">Do not include @deprecated information</td>
278 <td align="center" valign="top">all</td>
279 <td align="center" valign="top">No</td>
280 </tr>
281 <tr>
282 <td valign="top">nodeprecatedlist</td>
283 <td valign="top">Do not generate deprecated list</td>
284 <td align="center" valign="top">all</td>
285 <td align="center" valign="top">No</td>
286 </tr>
287 <tr>
288 <td valign="top">notree</td>
289 <td valign="top">Do not generate class hierarchy</td>
290 <td align="center" valign="top">all</td>
291 <td align="center" valign="top">No</td>
292 </tr>
293 <tr>
294 <td valign="top">noindex</td>
295 <td valign="top">Do not generate index</td>
296 <td align="center" valign="top">all</td>
297 <td align="center" valign="top">No</td>
298 </tr>
299 <tr>
300 <td valign="top">nohelp</td>
301 <td valign="top">Do not generate help link</td>
302 <td align="center" valign="top">all</td>
303 <td align="center" valign="top">No</td>
304 </tr>
305 <tr>
306 <td valign="top">nonavbar</td>
307 <td valign="top">Do not generate navigation bar</td>
308 <td align="center" valign="top">all</td>
309 <td align="center" valign="top">No</td>
310 </tr>
311 <tr>
312 <td valign="top">serialwarn</td>
313 <td valign="top">Generate warning about @serial tag</td>
314 <td align="center" valign="top">all</td>
315 <td align="center" valign="top">No</td>
316 </tr>
317 <tr>
318 <td valign="top">helpfile</td>
319 <td valign="top">Specifies the HTML help file to use</td>
320 <td align="center" valign="top">all</td>
321 <td align="center" valign="top">No</td>
322 </tr>
323 <tr>
324 <td valign="top">stylesheetfile</td>
325 <td valign="top">Specifies the CSS stylesheet to use</td>
326 <td align="center" valign="top">all</td>
327 <td align="center" valign="top">No</td>
328 </tr>
329 <tr>
330 <td valign="top">charset</td>
331 <td valign="top">Charset for cross-platform viewing of generated
332 documentation</td>
333 <td align="center" valign="top">all</td>
334 <td align="center" valign="top">No</td>
335 </tr>
336 <tr>
337 <td valign="top">docencoding</td>
338 <td valign="top">Output file encoding name</td>
339 <td align="center" valign="top">all</td>
340 <td align="center" valign="top">No</td>
341 </tr>
342 <tr>
343 <td valign="top">doclet</td>
344 <td valign="top">Specifies the class file that starts the doclet
345 used in generating the documentation -- see also the nested
346 <code>doclet</code> element.</td>
347 <td align="center" valign="top">all</td>
348 <td align="center" valign="top">No</td>
349 </tr>
350 <tr>
351 <td valign="top">docletpath</td>
352 <td valign="top">Specifies the path to the doclet class file that is specified with the -doclet option.</td>
353 <td align="center" valign="top">all</td>
354 <td align="center" valign="top">No</td>
355 </tr>
356 <tr>
357 <td valign="top">docletpathref</td>
358 <td valign="top">Specifies the path to the doclet class file that
359 is specified with the -doclet option by <a
360 href="../using.html#references">reference</a> to a PATH defined elsewhere.</td>
361 <td align="center" valign="top">all</td>
362 <td align="center" valign="top">No</td>
363 </tr>
364 <tr>
365 <td valign="top">additionalparam</td>
366 <td valign="top">Lets you add additional parameters to the javadoc
367 command line. Useful for doclets. Parameters containing spaces
368 need to be quoted using &amp;quot; -- see also the nested
369 <code>arg</code> element.</td>
370 <td align="center" valign="top">all</td>
371 <td align="center" valign="top">No</td>
372 </tr>
373 <tr>
374 <td valign="top">failonerror</td>
375 <td valign="top">Stop the buildprocess if the command exits with a
376 returncode other than 0.</td>
377 <td align="center" valign="top">all</td>
378 <td align="center" valign="top">No</td>
379 </tr>
380 <tr>
381 <td valign="top">excludepackagenames</td>
382 <td valign="top">comma separated list of packages you don't want
383 docs for -- see also the nested <code>excludepackage</code> element.</td>
384 <td align="center" valign="top">all</td>
385 <td valign="top" align="center">No</td>
386 </tr>
387 <tr>
388 <td valign="top">defaultexcludes</td>
389 <td valign="top">indicates whether default excludes should be used
390 (<code>yes</code> | <code>no</code>); default excludes are used when omitted.</td>
391 <td align="center" valign="top">all</td>
392 <td valign="top" align="center">No</td>
393 </tr>
394 <tr>
395 <td valign="top">useexternalfile</td>
396 <td valign="top">indicates whether the sourcefile name specified
397 in srcfiles or as nested source elements should be written to a
398 temporary file to make the command line shorter. Also applies to
399 the package names specified via the packagenames attribute or
400 nested package elements.
401 (<code>yes</code> | <code>no</code>). Default is no.</td>
402 <td align="center" valign="top">all</td>
403 <td valign="top" align="center">No</td>
404 </tr>
405 <tr>
406 <td valign="top">source</td>
407 <td valign="top">Necessary to enable javadoc to handle assertions
408 present in J2SE v 1.4 source code. Set this to &quot;1.4&quot; to
409 documents code that compiles using <code>&quot;javac -source
410 1.4&quot;</code>.</td>
411 <td align="center" valign="top">1.4+</td>
412 <td align="center" valign="top">No</td>
413 </tr>
414 <tr>
415 <td valign="top">linksource</td>
416 <td valign="top">Generate hyperlinks to source files.
417 <em>since Ant 1.6</em>.
418 (<code>yes</code> | <code>no</code>). Default is no.</td>
419 <td align="center" valign="top">1.4+</td>
420 <td align="center" valign="top">No</td>
421 </tr>
422 <tr>
423 <td valign="top">breakiterator</td>
424 <td valign="top">Use the new breakiterator algorithm.
425 <em>since Ant 1.6</em>.
426 (<code>yes</code> | <code>no</code>). Default is no.</td>
427 <td align="center" valign="top">1.4+</td>
428 <td align="center" valign="top">No</td>
429 </tr>
430 <tr>
431 <td valign="top">noqualifier</td>
432 <td valign="top">Enables the <code>-noqualifier</code> argument -
433 must be <code>all</code> or a colon separated list of packages.
434 <em>since Ant 1.6</em>.</td>
435 <td align="center" valign="top">1.4+</td>
436 <td align="center" valign="top">No</td>
437 </tr>
438 <tr>
439 <td valign="top">includenosourcepackages</td>
440 <td valign="top">If set to true, packages that don't contain Java
441 source but a package.html will get documented as well.
442 <em>since Ant 1.6.3</em>.</td>
443 <td align="center" valign="top">all</td>
444 <td align="center" valign="top">No (default is <code>false</code>)</td>
445 </tr>
446 <tr>
447 <td valign="top">executable</td>
448 <td valign="top">Specify a particular <code>javadoc</code> executable
449 to use in place of the default binary (found in the same JDK as Ant is running in).
450 <em>since Ant 1.6.3</em>.</td>
451 <td align="center" valign="top">all</td>
452 <td align="center" valign="top">No</td>
453 </tr>
454</table>
455
456<h4><a name="groupattribute">Format of the group attribute</a></h4>
457<p>The arguments are comma-delimited. Each single argument is 2
458space-delimited strings, where the first one is the group's title and
459the second one a colon delimited list of packages.</p>
460<p>If you need to specify more than one group, or a group whose title
461contains a comma or a space character, using <a
462href="#groupelement">nested group elements</a> is highly
463recommended.</p>
464<p>E.g.:</p>
465<pre> group=&quot;XSLT_Packages org.apache.xalan.xslt*,XPath_Packages org.apache.xalan.xpath*&quot;</pre>
466
467<h3>Parameters specified as nested elements</h3>
468
469<h4>packageset</h4>
470
471<p>A <a href="../CoreTypes/dirset.html">DirSet</a>. All matched
472directories that contain Java source files will be passed to javadoc
473as package names. Package names are created from the directory names
474by translating the directory separator into dots. Ant assumes the
475base directory of the packageset points to the root of a package
476hierarchy.</p>
477
478<p>The <code>packagenames</code>, <code>excludepackagenames</code> and
479<code>defaultexcludes</code> attributes of the task have no effect on
480the nested <code>&lt;packageset&gt;</code> elements.</p>
481
482<h4>fileset</h4>
483
484<p>A <a href="../CoreTypes/fileset.html">FileSet</a>. All matched
485files will be passed to javadoc as source files. Ant will
486automatically add the include pattern <code>**/*.java</code> (and
487<code>**/package.html</code> if inncludenosourcepackages is true) to
488these filesets.</p>
489
490<p>Nested filesets can be used to document sources that are in the
491default package or if you want to exclude certain files from
492documentation. If you want to document all source files and don't use
493the default package, packagesets should be used instead as this
494increases javadocs performance.</p>
495
496<p>The <code>packagenames</code>, <code>excludepackagenames</code> and
497<code>defaultexcludes</code> attributes of the task have no effect on
498the nested <code>&lt;fileset&gt;</code> elements.</p>
499
500<h4>package</h4>
501<p>Same as one entry in the list given by <code>packagenames</code>.</p>
502
503<h5>Parameters</h5>
504<table width="60%" border="1" cellpadding="2" cellspacing="0">
505 <tr>
506 <td valign="top"><b>Attribute</b></td>
507 <td valign="top"><b>Description</b></td>
508 <td align="center" valign="top"><b>Required</b></td>
509 </tr>
510 <tr>
511 <td valign="top">name</td>
512 <td valign="top">The package name (may be a wildcard)</td>
513 <td align="center" valign="top">Yes</td>
514 </tr>
515</table>
516
517<h4>excludepackage</h4>
518<p>Same as one entry in the list given by <code>excludepackagenames</code>.</p>
519
520<h5>Parameters</h5>
521Same as for <code>package</code>.
522
523<h4>source</h4>
524<p>Same as one entry in the list given by <code>sourcefiles</code>.</p>
525
526<h5>Parameters</h5>
527<table width="60%" border="1" cellpadding="2" cellspacing="0">
528 <tr>
529 <td valign="top"><b>Attribute</b></td>
530 <td valign="top"><b>Description</b></td>
531 <td align="center" valign="top"><b>Required</b></td>
532 </tr>
533 <tr>
534 <td valign="top">file</td>
535 <td valign="top">The source file to document</td>
536 <td align="center" valign="top">Yes</td>
537 </tr>
538</table>
539
540<h4>doctitle</h4>
541
542<p>Same as the <code>doctitle</code> attribute, but you can nest text
543inside the element this way.</p>
544
545<h4>header</h4>
546
547<p>Similar to <code>&lt;doctitle&gt;</code>.</p>
548
549<h4>footer</h4>
550
551<p>Similar to <code>&lt;doctitle&gt;</code>.</p>
552
553<h4>bottom</h4>
554
555<p>Similar to <code>&lt;doctitle&gt;</code>.</p>
556
557<h4>link</h4>
558<p>Create link to javadoc output at the given URL. This performs the
559same role as the link and linkoffline attributes. You can use either
560syntax (or both at once), but with the nested elements you can easily
561specify multiple occurrences of the arguments.</p>
562
563<h5>Parameters</h5>
564<table width="60%" border="1" cellpadding="2" cellspacing="0">
565 <tr>
566 <td valign="top"><b>Attribute</b></td>
567 <td valign="top"><b>Description</b></td>
568 <td align="center" valign="top"><b>Required</b></td>
569 </tr>
570 <tr>
571 <td valign="top">href</td>
572 <td valign="top">The URL for the external documentation you wish
573 to link to. This can be an absolute URL, or a relative file
574 name.</td>
575 <td align="center" valign="top">Yes</td>
576 </tr>
577 <tr>
578 <td valign="top">offline</td>
579 <td valign="top">True if this link is not available online at the time of
580 generating the documentation</td>
581 <td align="center" valign="top">No</td>
582 </tr>
583 <tr>
584 <td valign="top">packagelistLoc</td>
585 <td valign="top">The location to the directory containing the package-list file for
586 the external documentation</td>
587 <td align="center" valign="top">Only if the offline attribute is true</td>
588 </tr>
589 <tr>
590 <td valign="top">resolveLink</td>
591 <td valign="top">If the link attribute is a relative file name,
592 Ant will first try to locate the file relative to the current
593 project's basedir and if it finds a file there use an absolute URL
594 for the link attribute, otherwise it will pass the file name
595 verbatim to the javadoc command.</td>
596 <td align="center" valign="top">No, default is false.</td>
597 </tr>
598</table>
599
600<h4><a name="groupelement">group</a></h4>
601<p>Separates packages on the overview page into whatever groups you
602specify, one group per table. This performs the same role as the group
603attribute. You can use either syntax (or both at once), but with the
604nested elements you can easily specify multiple occurrences of the
605arguments.</p>
606
607<h5>Parameters</h5>
608<table width="60%" border="1" cellpadding="2" cellspacing="0">
609 <tr>
610 <td valign="top"><b>Attribute</b></td>
611 <td valign="top"><b>Description</b></td>
612 <td align="center" valign="top"><b>Required</b></td>
613 </tr>
614 <tr>
615 <td valign="top">title</td>
616 <td valign="top">Title of the group</td>
617 <td align="center" valign="top">Yes, unless nested <code>&lt;title&gt;</code> given</td>
618 </tr>
619 <tr>
620 <td valign="top">packages</td>
621 <td valign="top">List of packages to include in that group. Multiple packages are separated with ':'.</td>
622 <td align="center" valign="top">Yes, unless nested <code>&lt;package&gt;</code>s given</td>
623 </tr>
624</table>
625
626<p>The title may be specified as a nested <code>&lt;title&gt;</code> element
627with text contents, and the packages may be listed with nested
628<code>&lt;package&gt;</code> elements as for the main task.</p>
629
630<h4>doclet</h4>
631<p>The doclet nested element is used to specify the doclet that javadoc will
632use to process the input source files. A number of the standard javadoc arguments
633are actually arguments of the standard doclet. If these are specified in the javadoc
634task's attributes, they will be passed to the doclet specified in the
635<code>&lt;doclet&gt;</code> nested element. Such attributes should only be specified,
636therefore, if they can be interpreted by the doclet in use.</p>
637
638<p>If the doclet requires additional parameters, these can be specified with
639<code>&lt;param&gt;</code> elements within the <code>&lt;doclet&gt;</code>
640element. These parameters are restricted to simple strings. An example usage
641of the doclet element is shown below:</p>
642
643<pre> &lt;javadoc ... &gt;
644 &lt;doclet name=&quot;theDoclet&quot;
645 path=&quot;path/to/theDoclet&quot;&gt;
646 &lt;param name=&quot;-foo&quot; value=&quot;foovalue&quot;/&gt;
647 &lt;param name=&quot;-bar&quot; value=&quot;barvalue&quot;/&gt;
648 &lt;/doclet&gt;
649 &lt;/javadoc&gt;
650</pre>
651
652<h4><a name="tagelement">tag</a></h4>
653
654<p>The tag nested element is used to specify custom tags. This option
655is only available with Java 1.4.</p>
656
657<p>If you want to specify a standard tag using a nested tag element
658because you want to determine the order the tags are output, you must
659not set the description attribute for those tags.</p>
660
661<h5>Parameters</h5>
662<table width="60%" border="1" cellpadding="2" cellspacing="0">
663 <tr>
664 <td valign="top"><b>Attribute</b></td>
665 <td valign="top"><b>Description</b></td>
666 <td align="center" valign="top"><b>Required</b></td>
667 </tr>
668 <tr>
669 <td valign="top">name</td>
670 <td valign="top">Name of the tag (e.g. <code>todo</code>)</td>
671 <td align="center" valign="top">Yes, unless the <code>dir</code> attribute is specified.</td>
672 </tr>
673 <tr>
674 <td valign="top">description</td>
675 <td valign="top">Description for tag (e.g. <code>To do:</code>)</td>
676 <td align="center" valign="top">Yes, unless the <code>dir</code>
677 attribute is specified or name is a standard tag.</td>
678 </tr>
679 <tr>
680 <td valign="top">enabled</td>
681 <td valign="top">Whether or not the tag is enabled (defaults to <code>true</code>)</td>
682 <td align="center" valign="top">No</td>
683 </tr>
684 <tr>
685 <td valign="top">scope</td>
686 <td valign="top">Scope for the tag - the elements in which it can be used. This
687 is a comma separated list of some of the elements: <code>overview</code>,
688 <code>packages</code>, <code>types</code>, <code>constructors</code>,
689 <code>methods</code>, <code>fields</code> or the default, <code>all</code>.</td>
690 <td align="center" valign="top">No</td>
691 </tr>
692 <tr>
693 <td valign="top">dir</td>
694 <td valign="top">If this attribute is specified, this element will behave as an implicit
695 <a href="../CoreTypes/fileset.html">fileset</a>. The files included by this fileset should
696 contain each tag definition on a separate line, as described in the
697 <a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/javadoc.html#tag">Javadoc reference guide</a>:
698 <pre>ejb.bean:t:"XDoclet EJB Tag"
699todo:a:"To Do"</pre>
700 Note: If this attribute is specified, all the other attributes in this
701 element will be ignored.
702 </td>
703 <td align="center" valign="top">No</td>
704 </tr>
705</table>
706
707<h4><a name="tagletelement">taglet</a></h4>
708<p>The taglet nested element is used to specify custom taglets. This option is
709only available with Java 1.4.</p>
710
711<h5>Parameters</h5>
712<table width="60%" border="1" cellpadding="2" cellspacing="0">
713 <tr>
714 <td valign="top"><b>Attribute</b></td>
715 <td valign="top"><b>Description</b></td>
716 <td align="center" valign="top"><b>Required</b></td>
717 </tr>
718 <tr>
719 <td valign="top">name</td>
720 <td valign="top">The name of the taglet class
721 (e.g. <code>com.sun.tools.doclets.ToDoTaglet</code>)</td>
722 <td align="center" valign="top">Yes</td>
723 </tr>
724 <tr>
725 <td valign="top">path</td>
726 <td valign="top">A path specifying the search path for the taglet class
727 (e.g. <code>/home/taglets</code>).
728 The path may also be specified by a nested <code>&lt;path&gt;</code> element</td>
729 <td align="center" valign="top">No</td>
730 </tr>
731</table>
732
733<h4>sourcepath, classpath and bootclasspath</h4>
734<p><code>Javadoc</code>'s <i>sourcepath</i>, <i>classpath</i> and
735<i>bootclasspath</i> attributes are <a href="../using.html#path">PATH like
736structure</a> and can also be set via nested <i>sourcepath</i>,
737<i>classpath</i> and <i>bootclasspath</i> elements
738respectively.</p>
739
740<h4>arg</h4>
741
742<p>Use nested <code>&lt;arg&gt;</code> to specify additional
743arguments. See <a href="../using.html#arg">Command line
744arguments</a>. <em>Since Ant 1.6</em></p>
745
746<h3>Example</h3>
747<pre> &lt;javadoc packagenames=&quot;com.dummy.test.*&quot;
748 sourcepath=&quot;src&quot;
749 excludepackagenames=&quot;com.dummy.test.doc-files.*&quot;
750 defaultexcludes=&quot;yes&quot;
751 destdir=&quot;docs/api&quot;
752 author=&quot;true&quot;
753 version=&quot;true&quot;
754 use=&quot;true&quot;
755 windowtitle=&quot;Test API&quot;&gt;
756 &lt;doctitle&gt;&lt;![CDATA[&lt;h1&gt;Test&lt;/h1&gt;]]&gt;&lt;/doctitle&gt;
757 &lt;bottom&gt;&lt;![CDATA[&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;]]&gt;&lt;/bottom&gt;
758 &lt;tag name=&quot;todo&quot; scope=&quot;all&quot; description=&quot;To do:&quot;/&gt;
759 &lt;group title=&quot;Group 1 Packages&quot; packages=&quot;com.dummy.test.a*&quot;/&gt;
760 &lt;group title=&quot;Group 2 Packages&quot; packages=&quot;com.dummy.test.b*:com.dummy.test.c*&quot;/&gt;
761 &lt;link offline=&quot;true&quot; href=&quot;http://java.sun.com/products/jdk/1.2/docs/api/&quot; packagelistLoc=&quot;C:\tmp&quot;/&gt;
762 &lt;link href=&quot;http://developer.java.sun.com/developer/products/xml/docs/api/&quot;/&gt;
763 &lt/javadoc&gt;</pre>
764
765<p>is the same as</p>
766
767<pre> &lt;javadoc
768 destdir=&quot;docs/api&quot;
769 author=&quot;true&quot;
770 version=&quot;true&quot;
771 use=&quot;true&quot;
772 windowtitle=&quot;Test API&quot;&gt;
773
774 &lt;packageset dir=&quot;src&quot; defaultexcludes=&quot;yes&quot;&gt;
775 &lt;include name=&quot;com/dummy/test/**&quot;/&gt;
776 &lt;exclude name=&quot;com/dummy/test/doc-files/**&quot;/&gt;
777 &lt;/packageset&gt;
778
779 &lt;doctitle&gt;&lt;![CDATA[&lt;h1&gt;Test&lt;/h1&gt;]]&gt;&lt;/doctitle&gt;
780 &lt;bottom&gt;&lt;![CDATA[&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;]]&gt;&lt;/bottom&gt;
781 &lt;tag name=&quot;todo&quot; scope=&quot;all&quot; description=&quot;To do:&quot;/&gt;
782 &lt;group title=&quot;Group 1 Packages&quot; packages=&quot;com.dummy.test.a*&quot;/&gt;
783 &lt;group title=&quot;Group 2 Packages&quot; packages=&quot;com.dummy.test.b*:com.dummy.test.c*&quot;/&gt;
784 &lt;link offline=&quot;true&quot; href=&quot;http://java.sun.com/products/jdk/1.2/docs/api/&quot; packagelistLoc=&quot;C:\tmp&quot;/&gt;
785 &lt;link href=&quot;http://developer.java.sun.com/developer/products/xml/docs/api/&quot;/&gt;
786 &lt/javadoc&gt;</pre>
787
788<p>or</p>
789
790<pre> &lt;javadoc
791 destdir=&quot;docs/api&quot;
792 author=&quot;true&quot;
793 version=&quot;true&quot;
794 use=&quot;true&quot;
795 windowtitle=&quot;Test API&quot;&gt;
796
797 &lt;fileset dir=&quot;src&quot; defaultexcludes=&quot;yes&quot;&gt;
798 &lt;include name=&quot;com/dummy/test/**&quot;/&gt;
799 &lt;exclude name=&quot;com/dummy/test/doc-files/**&quot;/&gt;
800 &lt;/fileset&gt;
801
802 &lt;doctitle&gt;&lt;![CDATA[&lt;h1&gt;Test&lt;/h1&gt;]]&gt;&lt;/doctitle&gt;
803 &lt;bottom&gt;&lt;![CDATA[&lt;i&gt;Copyright &amp;#169; 2000 Dummy Corp. All Rights Reserved.&lt;/i&gt;]]&gt;&lt;/bottom&gt;
804 &lt;tag name=&quot;todo&quot; scope=&quot;all&quot; description=&quot;To do:&quot;/&gt;
805 &lt;group title=&quot;Group 1 Packages&quot; packages=&quot;com.dummy.test.a*&quot;/&gt;
806 &lt;group title=&quot;Group 2 Packages&quot; packages=&quot;com.dummy.test.b*:com.dummy.test.c*&quot;/&gt;
807 &lt;link offline=&quot;true&quot; href=&quot;http://java.sun.com/products/jdk/1.2/docs/api/&quot; packagelistLoc=&quot;C:\tmp&quot;/&gt;
808 &lt;link href=&quot;http://developer.java.sun.com/developer/products/xml/docs/api/&quot;/&gt;
809 &lt/javadoc&gt;</pre>
810
811<hr>
812<p align="center">Copyright &copy; 2000-2005 The Apache Software Foundation. All rights
813Reserved.</p>
814
815</body>
816</html>
817
Note: See TracBrowser for help on using the repository browser.