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