source: other-projects/trunk/realistic-books/packages/AntInstaller/web/manual/manual/CoreTasks/javadoc.html@ 19253

Last change on this file since 19253 was 19253, checked in by davidb, 15 years ago

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