Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/Javadoc.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago
initial import of the gs3-release-maker
File size: 88.0 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:20 NZST 2007 -->
6	<TITLE>
7	Javadoc (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Javadoc class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="Javadoc (Apache Ant API)";
18	}
19	</SCRIPT>
20
21	</HEAD>
22
23	<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26	<!-- ========= START OF TOP NAVBAR ======= -->
27	<A NAME="navbar_top"><!-- --></A>
28	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30	<TR>
31	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32	<A NAME="navbar_top_firstrow"><!-- --></A>
33	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34	<TR ALIGN="center" VALIGN="top">
35	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
42	</TR>
43	</TABLE>
44	</TD>
45	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46	</EM>
47	</TD>
48	</TR>
49
50	<TR>
51	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javac.ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
53	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
54	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
56	<A HREF="Javadoc.html" target="_top"><B>NO FRAMES</B></A>
57	<SCRIPT type="text/javascript">
58	<!--
59	if(window==top) {
60	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61	}
62	//-->
63	</SCRIPT>
64	<NOSCRIPT>
65	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66	</NOSCRIPT>
67
68	</FONT></TD>
69	</TR>
70	<TR>
71	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
75	</TR>
76	</TABLE>
77	<A NAME="skip-navbar_top"></A>
78	<!-- ========= END OF TOP NAVBAR ========= -->
79
80	<HR>
81	<!-- ======== START OF CLASS DATA ======== -->
82	<H2>
83	<FONT SIZE="-1">
84	org.apache.tools.ant.taskdefs</FONT>
85	<BR>
86	Class Javadoc</H2>
87	<PRE>
88	java.lang.Object
89	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Javadoc</B>
92	</PRE>
93	<HR>
94	<DL>
95	<DT>public class <B>Javadoc</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97	<P>
98	Generates Javadoc documentation for a collection
99	of source code.
100
101	<P>Current known limitations are:
102
103	<P><UL>
104	<LI>patterns must be of the form "xxx.*", every other pattern doesn't
105	work.
106	<LI>there is no control on arguments sanity since they are left
107	to the javadoc implementation.
108	</UL>
109
110	<P>If no <CODE>doclet</CODE> is set, then the <CODE>version</CODE> and
111	<CODE>author</CODE> are by default <CODE>"yes"</CODE>.
112
113	<P>Note: This task is run on another VM because the Javadoc code calls
114	<CODE>System.exit()</CODE> which would break Ant functionality.
115	<P>
116
117	<P>
118	<DL>
119	<DT><B>Since:</B></DT>
120	<DD>Ant 1.1</DD>
121	</DL>
122	<HR>
123
124	<P>
125	<!-- ======== NESTED CLASS SUMMARY ======== -->
126
127	<A NAME="nested_class_summary"><!-- --></A>
128	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130	<TD COLSPAN=2><FONT SIZE="+2">
131	<B>Nested Class Summary</B></FONT></TD>
132	</TR>
133	<TR BGCOLOR="white" CLASS="TableRowColor">
134	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135	<CODE>static class</CODE></FONT></TD>
136	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.AccessType</A></B></CODE>
137
138	<BR>
139	EnumeratedAttribute implementation supporting the javadoc scoping
140	values.</TD>
141	</TR>
142	<TR BGCOLOR="white" CLASS="TableRowColor">
143	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144	<CODE> class</CODE></FONT></TD>
145	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.DocletInfo</A></B></CODE>
146
147	<BR>
148	This class stores info about doclets.</TD>
149	</TR>
150	<TR BGCOLOR="white" CLASS="TableRowColor">
151	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152	<CODE> class</CODE></FONT></TD>
153	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.DocletParam.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.DocletParam</A></B></CODE>
154
155	<BR>
156	Inner class used to manage doclet parameters.</TD>
157	</TR>
158	<TR BGCOLOR="white" CLASS="TableRowColor">
159	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160	<CODE>static class</CODE></FONT></TD>
161	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.ExtensionInfo</A></B></CODE>
162
163	<BR>
164	A project aware class used for Javadoc extensions which take a name
165	and a path such as doclet and taglet arguments.</TD>
166	</TR>
167	<TR BGCOLOR="white" CLASS="TableRowColor">
168	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169	<CODE> class</CODE></FONT></TD>
170	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.GroupArgument</A></B></CODE>
171
172	<BR>
173	</TD>
174	</TR>
175	<TR BGCOLOR="white" CLASS="TableRowColor">
176	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
177	<CODE>static class</CODE></FONT></TD>
178	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A></B></CODE>
179
180	<BR>
181	An HTML element in the javadoc.</TD>
182	</TR>
183	<TR BGCOLOR="white" CLASS="TableRowColor">
184	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
185	<CODE> class</CODE></FONT></TD>
186	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.LinkArgument</A></B></CODE>
187
188	<BR>
189	Represents a link triplet (href, whether link is offline, location of the
190	package list if off line)</TD>
191	</TR>
192	<TR BGCOLOR="white" CLASS="TableRowColor">
193	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194	<CODE>static class</CODE></FONT></TD>
195	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.PackageName.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.PackageName</A></B></CODE>
196
197	<BR>
198	Used to track info about the packages to be javadoc'd</TD>
199	</TR>
200	<TR BGCOLOR="white" CLASS="TableRowColor">
201	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202	<CODE>static class</CODE></FONT></TD>
203	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.SourceFile</A></B></CODE>
204
205	<BR>
206	This class is used to manage the source files to be processed.</TD>
207	</TR>
208	<TR BGCOLOR="white" CLASS="TableRowColor">
209	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210	<CODE> class</CODE></FONT></TD>
211	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.TagArgument</A></B></CODE>
212
213	<BR>
214	Class representing a -tag argument.</TD>
215	</TR>
216	</TABLE>
217
218	<!-- =========== FIELD SUMMARY =========== -->
219
220	<A NAME="field_summary"><!-- --></A>
221	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
223	<TD COLSPAN=2><FONT SIZE="+2">
224	<B>Field Summary</B></FONT></TD>
225	</TR>
226	</TABLE>
227	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
228	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
229	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
230	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
231	</TR>
232	<TR BGCOLOR="white" CLASS="TableRowColor">
233	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
234	</TR>
235	</TABLE>
236	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
237	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
238	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
239	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
240	</TR>
241	<TR BGCOLOR="white" CLASS="TableRowColor">
242	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
243	</TR>
244	</TABLE>
245
246	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
247
248	<A NAME="constructor_summary"><!-- --></A>
249	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251	<TD COLSPAN=2><FONT SIZE="+2">
252	<B>Constructor Summary</B></FONT></TD>
253	</TR>
254	<TR BGCOLOR="white" CLASS="TableRowColor">
255	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#Javadoc()">Javadoc</A></B>()</CODE>
256
257	<BR>
258	</TD>
259	</TR>
260	</TABLE>
261
262	<!-- ========== METHOD SUMMARY =========== -->
263
264	<A NAME="method_summary"><!-- --></A>
265	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
266	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
267	<TD COLSPAN=2><FONT SIZE="+2">
268	<B>Method Summary</B></FONT></TD>
269	</TR>
270	<TR BGCOLOR="white" CLASS="TableRowColor">
271	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272	<CODE> void</CODE></FONT></TD>
273	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addBottom(org.apache.tools.ant.taskdefs.Javadoc.Html)">addBottom</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</CODE>
274
275	<BR>
276	Set the text to be placed at the bottom of each output file.</TD>
277	</TR>
278	<TR BGCOLOR="white" CLASS="TableRowColor">
279	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280	<CODE> void</CODE></FONT></TD>
281	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addDoctitle(org.apache.tools.ant.taskdefs.Javadoc.Html)">addDoctitle</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</CODE>
282
283	<BR>
284	Add a document title to use for the overview page.</TD>
285	</TR>
286	<TR BGCOLOR="white" CLASS="TableRowColor">
287	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
288	<CODE> void</CODE></FONT></TD>
289	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addExcludePackage(org.apache.tools.ant.taskdefs.Javadoc.PackageName)">addExcludePackage</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.PackageName.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.PackageName</A> pn)</CODE>
290
291	<BR>
292	Add a package to be excluded from the javadoc run.</TD>
293	</TR>
294	<TR BGCOLOR="white" CLASS="TableRowColor">
295	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296	<CODE> void</CODE></FONT></TD>
297	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> fs)</CODE>
298
299	<BR>
300	Adds a fileset.</TD>
301	</TR>
302	<TR BGCOLOR="white" CLASS="TableRowColor">
303	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304	<CODE> void</CODE></FONT></TD>
305	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addFooter(org.apache.tools.ant.taskdefs.Javadoc.Html)">addFooter</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</CODE>
306
307	<BR>
308	Set the footer text to be placed at the bottom of each output file.</TD>
309	</TR>
310	<TR BGCOLOR="white" CLASS="TableRowColor">
311	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312	<CODE> void</CODE></FONT></TD>
313	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addHeader(org.apache.tools.ant.taskdefs.Javadoc.Html)">addHeader</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</CODE>
314
315	<BR>
316	Set the header text to be placed at the top of each output file.</TD>
317	</TR>
318	<TR BGCOLOR="white" CLASS="TableRowColor">
319	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320	<CODE> void</CODE></FONT></TD>
321	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addPackage(org.apache.tools.ant.taskdefs.Javadoc.PackageName)">addPackage</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.PackageName.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.PackageName</A> pn)</CODE>
322
323	<BR>
324	Add a single package to be processed.</TD>
325	</TR>
326	<TR BGCOLOR="white" CLASS="TableRowColor">
327	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328	<CODE> void</CODE></FONT></TD>
329	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addPackageset(org.apache.tools.ant.types.DirSet)">addPackageset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/DirSet.html" title="class in org.apache.tools.ant.types">DirSet</A> packageSet)</CODE>
330
331	<BR>
332	Adds a packageset.</TD>
333	</TR>
334	<TR BGCOLOR="white" CLASS="TableRowColor">
335	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336	<CODE> void</CODE></FONT></TD>
337	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addSource(org.apache.tools.ant.taskdefs.Javadoc.SourceFile)">addSource</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.SourceFile</A> sf)</CODE>
338
339	<BR>
340	Add a single source file.</TD>
341	</TR>
342	<TR BGCOLOR="white" CLASS="TableRowColor">
343	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344	<CODE> void</CODE></FONT></TD>
345	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addTaglet(org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo)">addTaglet</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.ExtensionInfo</A> tagletInfo)</CODE>
346
347	<BR>
348	Add a taglet</TD>
349	</TR>
350	<TR BGCOLOR="white" CLASS="TableRowColor">
351	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A></CODE></FONT></TD>
353	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createArg()">createArg</A></B>()</CODE>
354
355	<BR>
356	Adds a command-line argument.</TD>
357	</TR>
358	<TR BGCOLOR="white" CLASS="TableRowColor">
359	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
360	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
361	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createBootclasspath()">createBootclasspath</A></B>()</CODE>
362
363	<BR>
364	Create a Path to be configured with the boot classpath</TD>
365	</TR>
366	<TR BGCOLOR="white" CLASS="TableRowColor">
367	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
368	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
369	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createClasspath()">createClasspath</A></B>()</CODE>
370
371	<BR>
372	Create a Path to be configured with the classpath to use</TD>
373	</TR>
374	<TR BGCOLOR="white" CLASS="TableRowColor">
375	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
376	<CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.DocletInfo</A></CODE></FONT></TD>
377	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createDoclet()">createDoclet</A></B>()</CODE>
378
379	<BR>
380	Create a doclet to be used in the documentation generation.</TD>
381	</TR>
382	<TR BGCOLOR="white" CLASS="TableRowColor">
383	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
384	<CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.GroupArgument</A></CODE></FONT></TD>
385	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createGroup()">createGroup</A></B>()</CODE>
386
387	<BR>
388	Separates packages on the overview page into whatever
389	groups you specify, one group per table.</TD>
390	</TR>
391	<TR BGCOLOR="white" CLASS="TableRowColor">
392	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
393	<CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.LinkArgument</A></CODE></FONT></TD>
394	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createLink()">createLink</A></B>()</CODE>
395
396	<BR>
397	Create link to javadoc output at the given URL.</TD>
398	</TR>
399	<TR BGCOLOR="white" CLASS="TableRowColor">
400	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
401	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
402	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createSourcepath()">createSourcepath</A></B>()</CODE>
403
404	<BR>
405	Create a path to be configured with the locations of the source
406	files.</TD>
407	</TR>
408	<TR BGCOLOR="white" CLASS="TableRowColor">
409	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410	<CODE> <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.TagArgument</A></CODE></FONT></TD>
411	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#createTag()">createTag</A></B>()</CODE>
412
413	<BR>
414	Creates and adds a -tag argument.</TD>
415	</TR>
416	<TR BGCOLOR="white" CLASS="TableRowColor">
417	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
418	<CODE> void</CODE></FONT></TD>
419	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#execute()">execute</A></B>()</CODE>
420
421	<BR>
422	Called by the project to let the task do its work.</TD>
423	</TR>
424	<TR BGCOLOR="white" CLASS="TableRowColor">
425	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426	<CODE>protected  java.lang.String</CODE></FONT></TD>
427	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#expand(java.lang.String)">expand</A></B>(java.lang.String content)</CODE>
428
429	<BR>
430	Convenience method to expand properties.</TD>
431	</TR>
432	<TR BGCOLOR="white" CLASS="TableRowColor">
433	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434	<CODE> void</CODE></FONT></TD>
435	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setAccess(org.apache.tools.ant.taskdefs.Javadoc.AccessType)">setAccess</A></B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.AccessType</A> at)</CODE>
436
437	<BR>
438	Set the scope to be processed.</TD>
439	</TR>
440	<TR BGCOLOR="white" CLASS="TableRowColor">
441	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442	<CODE> void</CODE></FONT></TD>
443	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setAdditionalparam(java.lang.String)">setAdditionalparam</A></B>(java.lang.String add)</CODE>
444
445	<BR>
446	Set an additional parameter on the command line</TD>
447	</TR>
448	<TR BGCOLOR="white" CLASS="TableRowColor">
449	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
450	<CODE> void</CODE></FONT></TD>
451	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setAuthor(boolean)">setAuthor</A></B>(boolean b)</CODE>
452
453	<BR>
454	Include the author tag in the generated documentation.</TD>
455	</TR>
456	<TR BGCOLOR="white" CLASS="TableRowColor">
457	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
458	<CODE> void</CODE></FONT></TD>
459	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setBootclasspath(org.apache.tools.ant.types.Path)">setBootclasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</CODE>
460
461	<BR>
462	Set the boot classpath to use.</TD>
463	</TR>
464	<TR BGCOLOR="white" CLASS="TableRowColor">
465	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
466	<CODE> void</CODE></FONT></TD>
467	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setBootClasspathRef(org.apache.tools.ant.types.Reference)">setBootClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</CODE>
468
469	<BR>
470	Adds a reference to a CLASSPATH defined elsewhere.</TD>
471	</TR>
472	<TR BGCOLOR="white" CLASS="TableRowColor">
473	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
474	<CODE> void</CODE></FONT></TD>
475	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setBottom(java.lang.String)">setBottom</A></B>(java.lang.String bottom)</CODE>
476
477	<BR>
478	Set the text to be placed at the bottom of each output file.</TD>
479	</TR>
480	<TR BGCOLOR="white" CLASS="TableRowColor">
481	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
482	<CODE> void</CODE></FONT></TD>
483	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setBreakiterator(boolean)">setBreakiterator</A></B>(boolean b)</CODE>
484
485	<BR>
486	Enables the -linksource switch, will be ignored if javadoc is not
487	the 1.4 version.</TD>
488	</TR>
489	<TR BGCOLOR="white" CLASS="TableRowColor">
490	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
491	<CODE> void</CODE></FONT></TD>
492	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setCharset(java.lang.String)">setCharset</A></B>(java.lang.String src)</CODE>
493
494	<BR>
495	Charset for cross-platform viewing of generated documentation.</TD>
496	</TR>
497	<TR BGCOLOR="white" CLASS="TableRowColor">
498	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
499	<CODE> void</CODE></FONT></TD>
500	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</CODE>
501
502	<BR>
503	Set the classpath to be used for this javadoc run.</TD>
504	</TR>
505	<TR BGCOLOR="white" CLASS="TableRowColor">
506	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
507	<CODE> void</CODE></FONT></TD>
508	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</CODE>
509
510	<BR>
511	Adds a reference to a CLASSPATH defined elsewhere.</TD>
512	</TR>
513	<TR BGCOLOR="white" CLASS="TableRowColor">
514	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
515	<CODE> void</CODE></FONT></TD>
516	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDefaultexcludes(boolean)">setDefaultexcludes</A></B>(boolean useDefaultExcludes)</CODE>
517
518	<BR>
519	Sets whether default exclusions should be used or not.</TD>
520	</TR>
521	<TR BGCOLOR="white" CLASS="TableRowColor">
522	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
523	<CODE> void</CODE></FONT></TD>
524	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDestdir(java.io.File)">setDestdir</A></B>(java.io.File dir)</CODE>
525
526	<BR>
527	Set the directory where the Javadoc output will be generated.</TD>
528	</TR>
529	<TR BGCOLOR="white" CLASS="TableRowColor">
530	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
531	<CODE> void</CODE></FONT></TD>
532	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDocencoding(java.lang.String)">setDocencoding</A></B>(java.lang.String enc)</CODE>
533
534	<BR>
535	Output file encoding name.</TD>
536	</TR>
537	<TR BGCOLOR="white" CLASS="TableRowColor">
538	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
539	<CODE> void</CODE></FONT></TD>
540	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDoclet(java.lang.String)">setDoclet</A></B>(java.lang.String docletName)</CODE>
541
542	<BR>
543	Set the class that starts the doclet used in generating the
544	documentation.</TD>
545	</TR>
546	<TR BGCOLOR="white" CLASS="TableRowColor">
547	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
548	<CODE> void</CODE></FONT></TD>
549	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDocletPath(org.apache.tools.ant.types.Path)">setDocletPath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> docletPath)</CODE>
550
551	<BR>
552	Set the classpath used to find the doclet class.</TD>
553	</TR>
554	<TR BGCOLOR="white" CLASS="TableRowColor">
555	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
556	<CODE> void</CODE></FONT></TD>
557	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDocletPathRef(org.apache.tools.ant.types.Reference)">setDocletPathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</CODE>
558
559	<BR>
560	Set the classpath used to find the doclet class by reference.</TD>
561	</TR>
562	<TR BGCOLOR="white" CLASS="TableRowColor">
563	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
564	<CODE> void</CODE></FONT></TD>
565	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setDoctitle(java.lang.String)">setDoctitle</A></B>(java.lang.String doctitle)</CODE>
566
567	<BR>
568	Set the title of the generated overview page.</TD>
569	</TR>
570	<TR BGCOLOR="white" CLASS="TableRowColor">
571	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572	<CODE> void</CODE></FONT></TD>
573	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String enc)</CODE>
574
575	<BR>
576	Set the encoding name of the source files,</TD>
577	</TR>
578	<TR BGCOLOR="white" CLASS="TableRowColor">
579	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
580	<CODE> void</CODE></FONT></TD>
581	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExcludePackageNames(java.lang.String)">setExcludePackageNames</A></B>(java.lang.String packages)</CODE>
582
583	<BR>
584	Set the list of packages to be excluded.</TD>
585	</TR>
586	<TR BGCOLOR="white" CLASS="TableRowColor">
587	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
588	<CODE> void</CODE></FONT></TD>
589	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExecutable(java.lang.String)">setExecutable</A></B>(java.lang.String executable)</CODE>
590
591	<BR>
592	Sets the actual executable command to invoke, instead of the binary
593	<code>javadoc</code> found in Ant's JDK.</TD>
594	</TR>
595	<TR BGCOLOR="white" CLASS="TableRowColor">
596	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
597	<CODE> void</CODE></FONT></TD>
598	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExtdirs(org.apache.tools.ant.types.Path)">setExtdirs</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</CODE>
599
600	<BR>
601	Set the location of the extensions directories.</TD>
602	</TR>
603	<TR BGCOLOR="white" CLASS="TableRowColor">
604	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
605	<CODE> void</CODE></FONT></TD>
606	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExtdirs(java.lang.String)">setExtdirs</A></B>(java.lang.String path)</CODE>
607
608	<BR>
609	<B>Deprecated.</B> <I>Use the <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExtdirs(org.apache.tools.ant.types.Path)"><CODE>setExtdirs(Path)</CODE></A> version.</I></TD>
610	</TR>
611	<TR BGCOLOR="white" CLASS="TableRowColor">
612	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
613	<CODE> void</CODE></FONT></TD>
614	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setFailonerror(boolean)">setFailonerror</A></B>(boolean b)</CODE>
615
616	<BR>
617	Should the build process fail if javadoc fails (as indicated by
618	a non zero return code)?
619
620	</TD>
621	</TR>
622	<TR BGCOLOR="white" CLASS="TableRowColor">
623	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
624	<CODE> void</CODE></FONT></TD>
625	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setFooter(java.lang.String)">setFooter</A></B>(java.lang.String footer)</CODE>
626
627	<BR>
628	Set the footer text to be placed at the bottom of each output file.</TD>
629	</TR>
630	<TR BGCOLOR="white" CLASS="TableRowColor">
631	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
632	<CODE> void</CODE></FONT></TD>
633	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setGroup(java.lang.String)">setGroup</A></B>(java.lang.String src)</CODE>
634
635	<BR>
636	Group specified packages together in overview page.</TD>
637	</TR>
638	<TR BGCOLOR="white" CLASS="TableRowColor">
639	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
640	<CODE> void</CODE></FONT></TD>
641	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setHeader(java.lang.String)">setHeader</A></B>(java.lang.String header)</CODE>
642
643	<BR>
644	Set the header text to be placed at the top of each output file.</TD>
645	</TR>
646	<TR BGCOLOR="white" CLASS="TableRowColor">
647	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
648	<CODE> void</CODE></FONT></TD>
649	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setHelpfile(java.io.File)">setHelpfile</A></B>(java.io.File f)</CODE>
650
651	<BR>
652	Specifies the HTML help file to use.</TD>
653	</TR>
654	<TR BGCOLOR="white" CLASS="TableRowColor">
655	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
656	<CODE> void</CODE></FONT></TD>
657	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setIncludeNoSourcePackages(boolean)">setIncludeNoSourcePackages</A></B>(boolean b)</CODE>
658
659	<BR>
660	If set to true, Ant will also accept packages that only hold
661	package.html files but no Java sources.</TD>
662	</TR>
663	<TR BGCOLOR="white" CLASS="TableRowColor">
664	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
665	<CODE> void</CODE></FONT></TD>
666	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setLink(java.lang.String)">setLink</A></B>(java.lang.String src)</CODE>
667
668	<BR>
669	Create links to javadoc output at the given URL.</TD>
670	</TR>
671	<TR BGCOLOR="white" CLASS="TableRowColor">
672	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
673	<CODE> void</CODE></FONT></TD>
674	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setLinkoffline(java.lang.String)">setLinkoffline</A></B>(java.lang.String src)</CODE>
675
676	<BR>
677	Link to docs at "url" using package list at "url2"
678	- separate the URLs by using a space character.</TD>
679	</TR>
680	<TR BGCOLOR="white" CLASS="TableRowColor">
681	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
682	<CODE> void</CODE></FONT></TD>
683	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setLinksource(boolean)">setLinksource</A></B>(boolean b)</CODE>
684
685	<BR>
686	Enables the -linksource switch, will be ignored if javadoc is not
687	the 1.4 version.</TD>
688	</TR>
689	<TR BGCOLOR="white" CLASS="TableRowColor">
690	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
691	<CODE> void</CODE></FONT></TD>
692	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setLocale(java.lang.String)">setLocale</A></B>(java.lang.String locale)</CODE>
693
694	<BR>
695	Set the local to use in documentation generation.</TD>
696	</TR>
697	<TR BGCOLOR="white" CLASS="TableRowColor">
698	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
699	<CODE> void</CODE></FONT></TD>
700	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setMaxmemory(java.lang.String)">setMaxmemory</A></B>(java.lang.String max)</CODE>
701
702	<BR>
703	Set the maximum memory to be used by the javadoc process</TD>
704	</TR>
705	<TR BGCOLOR="white" CLASS="TableRowColor">
706	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
707	<CODE> void</CODE></FONT></TD>
708	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNodeprecated(boolean)">setNodeprecated</A></B>(boolean b)</CODE>
709
710	<BR>
711	Control deprecation infromation</TD>
712	</TR>
713	<TR BGCOLOR="white" CLASS="TableRowColor">
714	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
715	<CODE> void</CODE></FONT></TD>
716	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNodeprecatedlist(boolean)">setNodeprecatedlist</A></B>(boolean b)</CODE>
717
718	<BR>
719	Control deprecated list generation</TD>
720	</TR>
721	<TR BGCOLOR="white" CLASS="TableRowColor">
722	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
723	<CODE> void</CODE></FONT></TD>
724	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNohelp(boolean)">setNohelp</A></B>(boolean b)</CODE>
725
726	<BR>
727	Control generation of help link.</TD>
728	</TR>
729	<TR BGCOLOR="white" CLASS="TableRowColor">
730	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
731	<CODE> void</CODE></FONT></TD>
732	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNoindex(boolean)">setNoindex</A></B>(boolean b)</CODE>
733
734	<BR>
735	Control generation of index.</TD>
736	</TR>
737	<TR BGCOLOR="white" CLASS="TableRowColor">
738	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
739	<CODE> void</CODE></FONT></TD>
740	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNonavbar(boolean)">setNonavbar</A></B>(boolean b)</CODE>
741
742	<BR>
743	Control generation of the navigation bar.</TD>
744	</TR>
745	<TR BGCOLOR="white" CLASS="TableRowColor">
746	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
747	<CODE> void</CODE></FONT></TD>
748	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNoqualifier(java.lang.String)">setNoqualifier</A></B>(java.lang.String noqualifier)</CODE>
749
750	<BR>
751	Enables the -noqualifier switch, will be ignored if javadoc is not
752	the 1.4 version.</TD>
753	</TR>
754	<TR BGCOLOR="white" CLASS="TableRowColor">
755	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
756	<CODE> void</CODE></FONT></TD>
757	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setNotree(boolean)">setNotree</A></B>(boolean b)</CODE>
758
759	<BR>
760	Control class tree generation.</TD>
761	</TR>
762	<TR BGCOLOR="white" CLASS="TableRowColor">
763	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
764	<CODE> void</CODE></FONT></TD>
765	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setOld(boolean)">setOld</A></B>(boolean b)</CODE>
766
767	<BR>
768	Indicate whether Javadoc should produce old style (JDK 1.1)
769	documentation.</TD>
770	</TR>
771	<TR BGCOLOR="white" CLASS="TableRowColor">
772	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
773	<CODE> void</CODE></FONT></TD>
774	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setOverview(java.io.File)">setOverview</A></B>(java.io.File f)</CODE>
775
776	<BR>
777	Specify the file containing the overview to be included in the generated
778	documentation.</TD>
779	</TR>
780	<TR BGCOLOR="white" CLASS="TableRowColor">
781	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
782	<CODE> void</CODE></FONT></TD>
783	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setPackage(boolean)">setPackage</A></B>(boolean b)</CODE>
784
785	<BR>
786	Indicate whether only package, protected and public classes and
787	members are to be included in the scope processed</TD>
788	</TR>
789	<TR BGCOLOR="white" CLASS="TableRowColor">
790	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
791	<CODE> void</CODE></FONT></TD>
792	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setPackageList(java.lang.String)">setPackageList</A></B>(java.lang.String src)</CODE>
793
794	<BR>
795	The name of a file containing the packages to process.</TD>
796	</TR>
797	<TR BGCOLOR="white" CLASS="TableRowColor">
798	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
799	<CODE> void</CODE></FONT></TD>
800	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setPackagenames(java.lang.String)">setPackagenames</A></B>(java.lang.String packages)</CODE>
801
802	<BR>
803	Set the package names to be processed.</TD>
804	</TR>
805	<TR BGCOLOR="white" CLASS="TableRowColor">
806	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
807	<CODE> void</CODE></FONT></TD>
808	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setPrivate(boolean)">setPrivate</A></B>(boolean b)</CODE>
809
810	<BR>
811	Indicate whether all classes and
812	members are to be included in the scope processed</TD>
813	</TR>
814	<TR BGCOLOR="white" CLASS="TableRowColor">
815	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
816	<CODE> void</CODE></FONT></TD>
817	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setProtected(boolean)">setProtected</A></B>(boolean b)</CODE>
818
819	<BR>
820	Indicate whether only protected and public classes and members are to
821	be included in the scope processed</TD>
822	</TR>
823	<TR BGCOLOR="white" CLASS="TableRowColor">
824	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
825	<CODE> void</CODE></FONT></TD>
826	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setPublic(boolean)">setPublic</A></B>(boolean b)</CODE>
827
828	<BR>
829	Indicate whether only public classes and members are to be included in
830	the scope processed</TD>
831	</TR>
832	<TR BGCOLOR="white" CLASS="TableRowColor">
833	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
834	<CODE> void</CODE></FONT></TD>
835	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSerialwarn(boolean)">setSerialwarn</A></B>(boolean b)</CODE>
836
837	<BR>
838	Control warnings about serial tag.</TD>
839	</TR>
840	<TR BGCOLOR="white" CLASS="TableRowColor">
841	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
842	<CODE> void</CODE></FONT></TD>
843	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSource(java.lang.String)">setSource</A></B>(java.lang.String source)</CODE>
844
845	<BR>
846	Enables the -source switch, will be ignored if javadoc is not
847	the 1.4 version.</TD>
848	</TR>
849	<TR BGCOLOR="white" CLASS="TableRowColor">
850	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
851	<CODE> void</CODE></FONT></TD>
852	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSourcefiles(java.lang.String)">setSourcefiles</A></B>(java.lang.String src)</CODE>
853
854	<BR>
855	Set the list of source files to process.</TD>
856	</TR>
857	<TR BGCOLOR="white" CLASS="TableRowColor">
858	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
859	<CODE> void</CODE></FONT></TD>
860	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSourcepath(org.apache.tools.ant.types.Path)">setSourcepath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> src)</CODE>
861
862	<BR>
863	Specify where to find source file</TD>
864	</TR>
865	<TR BGCOLOR="white" CLASS="TableRowColor">
866	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
867	<CODE> void</CODE></FONT></TD>
868	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSourcepathRef(org.apache.tools.ant.types.Reference)">setSourcepathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</CODE>
869
870	<BR>
871	Adds a reference to a CLASSPATH defined elsewhere.</TD>
872	</TR>
873	<TR BGCOLOR="white" CLASS="TableRowColor">
874	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
875	<CODE> void</CODE></FONT></TD>
876	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setSplitindex(boolean)">setSplitindex</A></B>(boolean b)</CODE>
877
878	<BR>
879	Generate a split index</TD>
880	</TR>
881	<TR BGCOLOR="white" CLASS="TableRowColor">
882	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
883	<CODE> void</CODE></FONT></TD>
884	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setStylesheetfile(java.io.File)">setStylesheetfile</A></B>(java.io.File f)</CODE>
885
886	<BR>
887	Specifies the CSS stylesheet file to use.</TD>
888	</TR>
889	<TR BGCOLOR="white" CLASS="TableRowColor">
890	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
891	<CODE> void</CODE></FONT></TD>
892	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setUse(boolean)">setUse</A></B>(boolean b)</CODE>
893
894	<BR>
895	Generate the "use&quot page for each package.</TD>
896	</TR>
897	<TR BGCOLOR="white" CLASS="TableRowColor">
898	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
899	<CODE> void</CODE></FONT></TD>
900	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setUseExternalFile(boolean)">setUseExternalFile</A></B>(boolean b)</CODE>
901
902	<BR>
903	Work around command line length limit by using an external file
904	for the sourcefiles.</TD>
905	</TR>
906	<TR BGCOLOR="white" CLASS="TableRowColor">
907	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
908	<CODE> void</CODE></FONT></TD>
909	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setVerbose(boolean)">setVerbose</A></B>(boolean b)</CODE>
910
911	<BR>
912	Run javadoc in verbose mode</TD>
913	</TR>
914	<TR BGCOLOR="white" CLASS="TableRowColor">
915	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
916	<CODE> void</CODE></FONT></TD>
917	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setVersion(boolean)">setVersion</A></B>(boolean b)</CODE>
918
919	<BR>
920	Include the version tag in the generated documentation.</TD>
921	</TR>
922	<TR BGCOLOR="white" CLASS="TableRowColor">
923	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
924	<CODE> void</CODE></FONT></TD>
925	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setWindowtitle(java.lang.String)">setWindowtitle</A></B>(java.lang.String title)</CODE>
926
927	<BR>
928	Set the title to be placed in the HTML <title> tag of the
929	generated documentation.</TD>
930	</TR>
931	</TABLE>
932	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
933	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
934	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
935	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
936	</TR>
937	<TR BGCOLOR="white" CLASS="TableRowColor">
938	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
939	</TR>
940	</TABLE>
941	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
942	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
943	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
944	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
945	</TR>
946	<TR BGCOLOR="white" CLASS="TableRowColor">
947	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
948	</TR>
949	</TABLE>
950	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
951	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
952	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
953	<TD><B>Methods inherited from class java.lang.Object</B></TD>
954	</TR>
955	<TR BGCOLOR="white" CLASS="TableRowColor">
956	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
957	</TR>
958	</TABLE>
959
960	<P>
961
962	<!-- ============ FIELD DETAIL =========== -->
963
964
965	<!-- ========= CONSTRUCTOR DETAIL ======== -->
966
967	<A NAME="constructor_detail"><!-- --></A>
968	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
969	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
970	<TD COLSPAN=1><FONT SIZE="+2">
971	<B>Constructor Detail</B></FONT></TD>
972	</TR>
973	</TABLE>
974
975	<A NAME="Javadoc()"><!-- --></A><H3>
976	Javadoc</H3>
977	<PRE>
978	public <B>Javadoc</B>()</PRE>
979	<DL>
980	</DL>
981
982	<!-- ============ METHOD DETAIL ========== -->
983
984	<A NAME="method_detail"><!-- --></A>
985	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
986	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
987	<TD COLSPAN=1><FONT SIZE="+2">
988	<B>Method Detail</B></FONT></TD>
989	</TR>
990	</TABLE>
991
992	<A NAME="setUseExternalFile(boolean)"><!-- --></A><H3>
993	setUseExternalFile</H3>
994	<PRE>
995	public void <B>setUseExternalFile</B>(boolean b)</PRE>
996	<DL>
997	<DD>Work around command line length limit by using an external file
998	for the sourcefiles.
999	<P>
1000	<DD><DL>
1001	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if an external file is to be used.</DL>
1002	</DD>
1003	</DL>
1004	<HR>
1005
1006	<A NAME="setDefaultexcludes(boolean)"><!-- --></A><H3>
1007	setDefaultexcludes</H3>
1008	<PRE>
1009	public void <B>setDefaultexcludes</B>(boolean useDefaultExcludes)</PRE>
1010	<DL>
1011	<DD>Sets whether default exclusions should be used or not.
1012	<P>
1013	<DD><DL>
1014	<DT><B>Parameters:</B><DD><CODE>useDefaultExcludes</CODE> - "true"\|"on"\|"yes" when default exclusions
1015	should be used, "false"\|"off"\|"no" when they
1016	shouldn't be used.</DL>
1017	</DD>
1018	</DL>
1019	<HR>
1020
1021	<A NAME="setMaxmemory(java.lang.String)"><!-- --></A><H3>
1022	setMaxmemory</H3>
1023	<PRE>
1024	public void <B>setMaxmemory</B>(java.lang.String max)</PRE>
1025	<DL>
1026	<DD>Set the maximum memory to be used by the javadoc process
1027	<P>
1028	<DD><DL>
1029	<DT><B>Parameters:</B><DD><CODE>max</CODE> - a string indicating the maximum memory according to the
1030	JVM conventions (e.g. 128m is 128 Megabytes)</DL>
1031	</DD>
1032	</DL>
1033	<HR>
1034
1035	<A NAME="setAdditionalparam(java.lang.String)"><!-- --></A><H3>
1036	setAdditionalparam</H3>
1037	<PRE>
1038	public void <B>setAdditionalparam</B>(java.lang.String add)</PRE>
1039	<DL>
1040	<DD>Set an additional parameter on the command line
1041	<P>
1042	<DD><DL>
1043	<DT><B>Parameters:</B><DD><CODE>add</CODE> - the additional command line parameter for the javadoc task.</DL>
1044	</DD>
1045	</DL>
1046	<HR>
1047
1048	<A NAME="createArg()"><!-- --></A><H3>
1049	createArg</H3>
1050	<PRE>
1051	public <A HREF="../../../../../org/apache/tools/ant/types/Commandline.Argument.html" title="class in org.apache.tools.ant.types">Commandline.Argument</A> <B>createArg</B>()</PRE>
1052	<DL>
1053	<DD>Adds a command-line argument.
1054	<P>
1055	<DD><DL>
1056	<DT><B>Since:</B></DT>
1057	<DD>Ant 1.6</DD>
1058	</DL>
1059	</DD>
1060	</DL>
1061	<HR>
1062
1063	<A NAME="setSourcepath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
1064	setSourcepath</H3>
1065	<PRE>
1066	public void <B>setSourcepath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> src)</PRE>
1067	<DL>
1068	<DD>Specify where to find source file
1069	<P>
1070	<DD><DL>
1071	<DT><B>Parameters:</B><DD><CODE>src</CODE> - a Path instance containing the various source directories.</DL>
1072	</DD>
1073	</DL>
1074	<HR>
1075
1076	<A NAME="createSourcepath()"><!-- --></A><H3>
1077	createSourcepath</H3>
1078	<PRE>
1079	public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createSourcepath</B>()</PRE>
1080	<DL>
1081	<DD>Create a path to be configured with the locations of the source
1082	files.
1083	<P>
1084	<DD><DL>
1085
1086	<DT><B>Returns:</B><DD>a new Path instance to be configured by the Ant core.</DL>
1087	</DD>
1088	</DL>
1089	<HR>
1090
1091	<A NAME="setSourcepathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
1092	setSourcepathRef</H3>
1093	<PRE>
1094	public void <B>setSourcepathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</PRE>
1095	<DL>
1096	<DD>Adds a reference to a CLASSPATH defined elsewhere.
1097	<P>
1098	<DD><DL>
1099	<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference containing the source path definition.</DL>
1100	</DD>
1101	</DL>
1102	<HR>
1103
1104	<A NAME="setDestdir(java.io.File)"><!-- --></A><H3>
1105	setDestdir</H3>
1106	<PRE>
1107	public void <B>setDestdir</B>(java.io.File dir)</PRE>
1108	<DL>
1109	<DD>Set the directory where the Javadoc output will be generated.
1110	<P>
1111	<DD><DL>
1112	<DT><B>Parameters:</B><DD><CODE>dir</CODE> - the destination directory.</DL>
1113	</DD>
1114	</DL>
1115	<HR>
1116
1117	<A NAME="setSourcefiles(java.lang.String)"><!-- --></A><H3>
1118	setSourcefiles</H3>
1119	<PRE>
1120	public void <B>setSourcefiles</B>(java.lang.String src)</PRE>
1121	<DL>
1122	<DD>Set the list of source files to process.
1123	<P>
1124	<DD><DL>
1125	<DT><B>Parameters:</B><DD><CODE>src</CODE> - a comma separated list of source files.</DL>
1126	</DD>
1127	</DL>
1128	<HR>
1129
1130	<A NAME="addSource(org.apache.tools.ant.taskdefs.Javadoc.SourceFile)"><!-- --></A><H3>
1131	addSource</H3>
1132	<PRE>
1133	public void <B>addSource</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.SourceFile.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.SourceFile</A> sf)</PRE>
1134	<DL>
1135	<DD>Add a single source file.
1136	<P>
1137	<DD><DL>
1138	<DT><B>Parameters:</B><DD><CODE>sf</CODE> - the source file to be processed.</DL>
1139	</DD>
1140	</DL>
1141	<HR>
1142
1143	<A NAME="setPackagenames(java.lang.String)"><!-- --></A><H3>
1144	setPackagenames</H3>
1145	<PRE>
1146	public void <B>setPackagenames</B>(java.lang.String packages)</PRE>
1147	<DL>
1148	<DD>Set the package names to be processed.
1149	<P>
1150	<DD><DL>
1151	<DT><B>Parameters:</B><DD><CODE>packages</CODE> - a comma separated list of packages specs
1152	(may be wildcarded).<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#addPackage(org.apache.tools.ant.taskdefs.Javadoc.PackageName)"><CODE>for wildcard information.</CODE></A></DL>
1153	</DD>
1154	</DL>
1155	<HR>
1156
1157	<A NAME="addPackage(org.apache.tools.ant.taskdefs.Javadoc.PackageName)"><!-- --></A><H3>
1158	addPackage</H3>
1159	<PRE>
1160	public void <B>addPackage</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.PackageName.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.PackageName</A> pn)</PRE>
1161	<DL>
1162	<DD>Add a single package to be processed.
1163
1164	If the package name ends with ".*" the Javadoc task
1165	will find and process all subpackages.
1166	<P>
1167	<DD><DL>
1168	<DT><B>Parameters:</B><DD><CODE>pn</CODE> - the package name, possibly wildcarded.</DL>
1169	</DD>
1170	</DL>
1171	<HR>
1172
1173	<A NAME="setExcludePackageNames(java.lang.String)"><!-- --></A><H3>
1174	setExcludePackageNames</H3>
1175	<PRE>
1176	public void <B>setExcludePackageNames</B>(java.lang.String packages)</PRE>
1177	<DL>
1178	<DD>Set the list of packages to be excluded.
1179	<P>
1180	<DD><DL>
1181	<DT><B>Parameters:</B><DD><CODE>packages</CODE> - a comma separated list of packages to be excluded.
1182	This may not include wildcards.</DL>
1183	</DD>
1184	</DL>
1185	<HR>
1186
1187	<A NAME="addExcludePackage(org.apache.tools.ant.taskdefs.Javadoc.PackageName)"><!-- --></A><H3>
1188	addExcludePackage</H3>
1189	<PRE>
1190	public void <B>addExcludePackage</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.PackageName.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.PackageName</A> pn)</PRE>
1191	<DL>
1192	<DD>Add a package to be excluded from the javadoc run.
1193	<P>
1194	<DD><DL>
1195	<DT><B>Parameters:</B><DD><CODE>pn</CODE> - the name of the package (wildcards are not permitted).</DL>
1196	</DD>
1197	</DL>
1198	<HR>
1199
1200	<A NAME="setOverview(java.io.File)"><!-- --></A><H3>
1201	setOverview</H3>
1202	<PRE>
1203	public void <B>setOverview</B>(java.io.File f)</PRE>
1204	<DL>
1205	<DD>Specify the file containing the overview to be included in the generated
1206	documentation.
1207	<P>
1208	<DD><DL>
1209	<DT><B>Parameters:</B><DD><CODE>f</CODE> - the file containing the overview.</DL>
1210	</DD>
1211	</DL>
1212	<HR>
1213
1214	<A NAME="setPublic(boolean)"><!-- --></A><H3>
1215	setPublic</H3>
1216	<PRE>
1217	public void <B>setPublic</B>(boolean b)</PRE>
1218	<DL>
1219	<DD>Indicate whether only public classes and members are to be included in
1220	the scope processed
1221	<P>
1222	<DD><DL>
1223	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if scope is to be public.</DL>
1224	</DD>
1225	</DL>
1226	<HR>
1227
1228	<A NAME="setProtected(boolean)"><!-- --></A><H3>
1229	setProtected</H3>
1230	<PRE>
1231	public void <B>setProtected</B>(boolean b)</PRE>
1232	<DL>
1233	<DD>Indicate whether only protected and public classes and members are to
1234	be included in the scope processed
1235	<P>
1236	<DD><DL>
1237	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if scope is to be protected.</DL>
1238	</DD>
1239	</DL>
1240	<HR>
1241
1242	<A NAME="setPackage(boolean)"><!-- --></A><H3>
1243	setPackage</H3>
1244	<PRE>
1245	public void <B>setPackage</B>(boolean b)</PRE>
1246	<DL>
1247	<DD>Indicate whether only package, protected and public classes and
1248	members are to be included in the scope processed
1249	<P>
1250	<DD><DL>
1251	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if scope is to be package level.</DL>
1252	</DD>
1253	</DL>
1254	<HR>
1255
1256	<A NAME="setPrivate(boolean)"><!-- --></A><H3>
1257	setPrivate</H3>
1258	<PRE>
1259	public void <B>setPrivate</B>(boolean b)</PRE>
1260	<DL>
1261	<DD>Indicate whether all classes and
1262	members are to be included in the scope processed
1263	<P>
1264	<DD><DL>
1265	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if scope is to be private level.</DL>
1266	</DD>
1267	</DL>
1268	<HR>
1269
1270	<A NAME="setAccess(org.apache.tools.ant.taskdefs.Javadoc.AccessType)"><!-- --></A><H3>
1271	setAccess</H3>
1272	<PRE>
1273	public void <B>setAccess</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.AccessType</A> at)</PRE>
1274	<DL>
1275	<DD>Set the scope to be processed. This is an alternative to the
1276	use of the setPublic, setPrivate, etc methods. It gives better build
1277	file control over what scope is processed.
1278	<P>
1279	<DD><DL>
1280	<DT><B>Parameters:</B><DD><CODE>at</CODE> - the scope to be processed.</DL>
1281	</DD>
1282	</DL>
1283	<HR>
1284
1285	<A NAME="setDoclet(java.lang.String)"><!-- --></A><H3>
1286	setDoclet</H3>
1287	<PRE>
1288	public void <B>setDoclet</B>(java.lang.String docletName)</PRE>
1289	<DL>
1290	<DD>Set the class that starts the doclet used in generating the
1291	documentation.
1292	<P>
1293	<DD><DL>
1294	<DT><B>Parameters:</B><DD><CODE>docletName</CODE> - the name of the doclet class.</DL>
1295	</DD>
1296	</DL>
1297	<HR>
1298
1299	<A NAME="setDocletPath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
1300	setDocletPath</H3>
1301	<PRE>
1302	public void <B>setDocletPath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> docletPath)</PRE>
1303	<DL>
1304	<DD>Set the classpath used to find the doclet class.
1305	<P>
1306	<DD><DL>
1307	<DT><B>Parameters:</B><DD><CODE>docletPath</CODE> - the doclet classpath.</DL>
1308	</DD>
1309	</DL>
1310	<HR>
1311
1312	<A NAME="setDocletPathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
1313	setDocletPathRef</H3>
1314	<PRE>
1315	public void <B>setDocletPathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</PRE>
1316	<DL>
1317	<DD>Set the classpath used to find the doclet class by reference.
1318	<P>
1319	<DD><DL>
1320	<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference to the Path instance to use as the doclet
1321	classpath.</DL>
1322	</DD>
1323	</DL>
1324	<HR>
1325
1326	<A NAME="createDoclet()"><!-- --></A><H3>
1327	createDoclet</H3>
1328	<PRE>
1329	public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.DocletInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.DocletInfo</A> <B>createDoclet</B>()</PRE>
1330	<DL>
1331	<DD>Create a doclet to be used in the documentation generation.
1332	<P>
1333	<DD><DL>
1334
1335	<DT><B>Returns:</B><DD>a new DocletInfo instance to be configured.</DL>
1336	</DD>
1337	</DL>
1338	<HR>
1339
1340	<A NAME="addTaglet(org.apache.tools.ant.taskdefs.Javadoc.ExtensionInfo)"><!-- --></A><H3>
1341	addTaglet</H3>
1342	<PRE>
1343	public void <B>addTaglet</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.ExtensionInfo.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.ExtensionInfo</A> tagletInfo)</PRE>
1344	<DL>
1345	<DD>Add a taglet
1346	<P>
1347	<DD><DL>
1348	<DT><B>Parameters:</B><DD><CODE>tagletInfo</CODE> - information about the taglet.</DL>
1349	</DD>
1350	</DL>
1351	<HR>
1352
1353	<A NAME="setOld(boolean)"><!-- --></A><H3>
1354	setOld</H3>
1355	<PRE>
1356	public void <B>setOld</B>(boolean b)</PRE>
1357	<DL>
1358	<DD>Indicate whether Javadoc should produce old style (JDK 1.1)
1359	documentation.
1360
1361	This is not supported by JDK 1.1 and has been phased out in JDK 1.4
1362	<P>
1363	<DD><DL>
1364	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true attempt to generate old style documentation.</DL>
1365	</DD>
1366	</DL>
1367	<HR>
1368
1369	<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
1370	setClasspath</H3>
1371	<PRE>
1372	public void <B>setClasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</PRE>
1373	<DL>
1374	<DD>Set the classpath to be used for this javadoc run.
1375	<P>
1376	<DD><DL>
1377	<DT><B>Parameters:</B><DD><CODE>path</CODE> - an Ant Path object containing the compilation
1378	classpath.</DL>
1379	</DD>
1380	</DL>
1381	<HR>
1382
1383	<A NAME="createClasspath()"><!-- --></A><H3>
1384	createClasspath</H3>
1385	<PRE>
1386	public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
1387	<DL>
1388	<DD>Create a Path to be configured with the classpath to use
1389	<P>
1390	<DD><DL>
1391
1392	<DT><B>Returns:</B><DD>a new Path instance to be configured with the classpath.</DL>
1393	</DD>
1394	</DL>
1395	<HR>
1396
1397	<A NAME="setClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
1398	setClasspathRef</H3>
1399	<PRE>
1400	public void <B>setClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</PRE>
1401	<DL>
1402	<DD>Adds a reference to a CLASSPATH defined elsewhere.
1403	<P>
1404	<DD><DL>
1405	<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference to an instance defining the classpath.</DL>
1406	</DD>
1407	</DL>
1408	<HR>
1409
1410	<A NAME="setBootclasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
1411	setBootclasspath</H3>
1412	<PRE>
1413	public void <B>setBootclasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</PRE>
1414	<DL>
1415	<DD>Set the boot classpath to use.
1416	<P>
1417	<DD><DL>
1418	<DT><B>Parameters:</B><DD><CODE>path</CODE> - the boot classpath.</DL>
1419	</DD>
1420	</DL>
1421	<HR>
1422
1423	<A NAME="createBootclasspath()"><!-- --></A><H3>
1424	createBootclasspath</H3>
1425	<PRE>
1426	public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createBootclasspath</B>()</PRE>
1427	<DL>
1428	<DD>Create a Path to be configured with the boot classpath
1429	<P>
1430	<DD><DL>
1431
1432	<DT><B>Returns:</B><DD>a new Path instance to be configured with the boot classpath.</DL>
1433	</DD>
1434	</DL>
1435	<HR>
1436
1437	<A NAME="setBootClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
1438	setBootClasspathRef</H3>
1439	<PRE>
1440	public void <B>setBootClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A> r)</PRE>
1441	<DL>
1442	<DD>Adds a reference to a CLASSPATH defined elsewhere.
1443	<P>
1444	<DD><DL>
1445	<DT><B>Parameters:</B><DD><CODE>r</CODE> - the reference to an instance defining the bootclasspath.</DL>
1446	</DD>
1447	</DL>
1448	<HR>
1449
1450	<A NAME="setExtdirs(java.lang.String)"><!-- --></A><H3>
1451	setExtdirs</H3>
1452	<PRE>
1453	public void <B>setExtdirs</B>(java.lang.String path)</PRE>
1454	<DL>
1455	<DD><B>Deprecated.</B> <I>Use the <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.html#setExtdirs(org.apache.tools.ant.types.Path)"><CODE>setExtdirs(Path)</CODE></A> version.</I>
1456	<P>
1457	<DD>Set the location of the extensions directories.
1458	<P>
1459	<DD><DL>
1460	<DT><B>Parameters:</B><DD><CODE>path</CODE> - the string version of the path.</DL>
1461	</DD>
1462	</DL>
1463	<HR>
1464
1465	<A NAME="setExtdirs(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
1466	setExtdirs</H3>
1467	<PRE>
1468	public void <B>setExtdirs</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> path)</PRE>
1469	<DL>
1470	<DD>Set the location of the extensions directories.
1471	<P>
1472	<DD><DL>
1473	<DT><B>Parameters:</B><DD><CODE>path</CODE> - a path containing the extension directories.</DL>
1474	</DD>
1475	</DL>
1476	<HR>
1477
1478	<A NAME="setVerbose(boolean)"><!-- --></A><H3>
1479	setVerbose</H3>
1480	<PRE>
1481	public void <B>setVerbose</B>(boolean b)</PRE>
1482	<DL>
1483	<DD>Run javadoc in verbose mode
1484	<P>
1485	<DD><DL>
1486	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if operation is to be verbose.</DL>
1487	</DD>
1488	</DL>
1489	<HR>
1490
1491	<A NAME="setLocale(java.lang.String)"><!-- --></A><H3>
1492	setLocale</H3>
1493	<PRE>
1494	public void <B>setLocale</B>(java.lang.String locale)</PRE>
1495	<DL>
1496	<DD>Set the local to use in documentation generation.
1497	<P>
1498	<DD><DL>
1499	<DT><B>Parameters:</B><DD><CODE>locale</CODE> - the locale to use.</DL>
1500	</DD>
1501	</DL>
1502	<HR>
1503
1504	<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
1505	setEncoding</H3>
1506	<PRE>
1507	public void <B>setEncoding</B>(java.lang.String enc)</PRE>
1508	<DL>
1509	<DD>Set the encoding name of the source files,
1510	<P>
1511	<DD><DL>
1512	<DT><B>Parameters:</B><DD><CODE>enc</CODE> - the name of the encoding for the source files.</DL>
1513	</DD>
1514	</DL>
1515	<HR>
1516
1517	<A NAME="setVersion(boolean)"><!-- --></A><H3>
1518	setVersion</H3>
1519	<PRE>
1520	public void <B>setVersion</B>(boolean b)</PRE>
1521	<DL>
1522	<DD>Include the version tag in the generated documentation.
1523	<P>
1524	<DD><DL>
1525	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the version tag should be included.</DL>
1526	</DD>
1527	</DL>
1528	<HR>
1529
1530	<A NAME="setUse(boolean)"><!-- --></A><H3>
1531	setUse</H3>
1532	<PRE>
1533	public void <B>setUse</B>(boolean b)</PRE>
1534	<DL>
1535	<DD>Generate the "use&quot page for each package.
1536	<P>
1537	<DD><DL>
1538	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the use page should be generated.</DL>
1539	</DD>
1540	</DL>
1541	<HR>
1542
1543	<A NAME="setAuthor(boolean)"><!-- --></A><H3>
1544	setAuthor</H3>
1545	<PRE>
1546	public void <B>setAuthor</B>(boolean b)</PRE>
1547	<DL>
1548	<DD>Include the author tag in the generated documentation.
1549	<P>
1550	<DD><DL>
1551	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the author tag should be included.</DL>
1552	</DD>
1553	</DL>
1554	<HR>
1555
1556	<A NAME="setSplitindex(boolean)"><!-- --></A><H3>
1557	setSplitindex</H3>
1558	<PRE>
1559	public void <B>setSplitindex</B>(boolean b)</PRE>
1560	<DL>
1561	<DD>Generate a split index
1562	<P>
1563	<DD><DL>
1564	<DT><B>Parameters:</B><DD><CODE>b</CODE> - true if the index should be split into a file per letter.</DL>
1565	</DD>
1566	</DL>
1567	<HR>
1568
1569	<A NAME="setWindowtitle(java.lang.String)"><!-- --></A><H3>
1570	setWindowtitle</H3>
1571	<PRE>
1572	public void <B>setWindowtitle</B>(java.lang.String title)</PRE>
1573	<DL>
1574	<DD>Set the title to be placed in the HTML <title> tag of the
1575	generated documentation.
1576	<P>
1577	<DD><DL>
1578	<DT><B>Parameters:</B><DD><CODE>title</CODE> - the window title to use.</DL>
1579	</DD>
1580	</DL>
1581	<HR>
1582
1583	<A NAME="setDoctitle(java.lang.String)"><!-- --></A><H3>
1584	setDoctitle</H3>
1585	<PRE>
1586	public void <B>setDoctitle</B>(java.lang.String doctitle)</PRE>
1587	<DL>
1588	<DD>Set the title of the generated overview page.
1589	<P>
1590	<DD><DL>
1591	<DT><B>Parameters:</B><DD><CODE>doctitle</CODE> - the Document title.</DL>
1592	</DD>
1593	</DL>
1594	<HR>
1595
1596	<A NAME="addDoctitle(org.apache.tools.ant.taskdefs.Javadoc.Html)"><!-- --></A><H3>
1597	addDoctitle</H3>
1598	<PRE>
1599	public void <B>addDoctitle</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</PRE>
1600	<DL>
1601	<DD>Add a document title to use for the overview page.
1602	<P>
1603	<DD><DL>
1604	<DT><B>Parameters:</B><DD><CODE>text</CODE> - the HTML element containing the document title.</DL>
1605	</DD>
1606	</DL>
1607	<HR>
1608
1609	<A NAME="setHeader(java.lang.String)"><!-- --></A><H3>
1610	setHeader</H3>
1611	<PRE>
1612	public void <B>setHeader</B>(java.lang.String header)</PRE>
1613	<DL>
1614	<DD>Set the header text to be placed at the top of each output file.
1615	<P>
1616	<DD><DL>
1617	<DT><B>Parameters:</B><DD><CODE>header</CODE> - the header text</DL>
1618	</DD>
1619	</DL>
1620	<HR>
1621
1622	<A NAME="addHeader(org.apache.tools.ant.taskdefs.Javadoc.Html)"><!-- --></A><H3>
1623	addHeader</H3>
1624	<PRE>
1625	public void <B>addHeader</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</PRE>
1626	<DL>
1627	<DD>Set the header text to be placed at the top of each output file.
1628	<P>
1629	<DD><DL>
1630	<DT><B>Parameters:</B><DD><CODE>text</CODE> - the header text</DL>
1631	</DD>
1632	</DL>
1633	<HR>
1634
1635	<A NAME="setFooter(java.lang.String)"><!-- --></A><H3>
1636	setFooter</H3>
1637	<PRE>
1638	public void <B>setFooter</B>(java.lang.String footer)</PRE>
1639	<DL>
1640	<DD>Set the footer text to be placed at the bottom of each output file.
1641	<P>
1642	<DD><DL>
1643	<DT><B>Parameters:</B><DD><CODE>footer</CODE> - the footer text.</DL>
1644	</DD>
1645	</DL>
1646	<HR>
1647
1648	<A NAME="addFooter(org.apache.tools.ant.taskdefs.Javadoc.Html)"><!-- --></A><H3>
1649	addFooter</H3>
1650	<PRE>
1651	public void <B>addFooter</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</PRE>
1652	<DL>
1653	<DD>Set the footer text to be placed at the bottom of each output file.
1654	<P>
1655	<DD><DL>
1656	<DT><B>Parameters:</B><DD><CODE>text</CODE> - the footer text.</DL>
1657	</DD>
1658	</DL>
1659	<HR>
1660
1661	<A NAME="setBottom(java.lang.String)"><!-- --></A><H3>
1662	setBottom</H3>
1663	<PRE>
1664	public void <B>setBottom</B>(java.lang.String bottom)</PRE>
1665	<DL>
1666	<DD>Set the text to be placed at the bottom of each output file.
1667	<P>
1668	<DD><DL>
1669	<DT><B>Parameters:</B><DD><CODE>bottom</CODE> - the bottom text.</DL>
1670	</DD>
1671	</DL>
1672	<HR>
1673
1674	<A NAME="addBottom(org.apache.tools.ant.taskdefs.Javadoc.Html)"><!-- --></A><H3>
1675	addBottom</H3>
1676	<PRE>
1677	public void <B>addBottom</B>(<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.Html.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.Html</A> text)</PRE>
1678	<DL>
1679	<DD>Set the text to be placed at the bottom of each output file.
1680	<P>
1681	<DD><DL>
1682	<DT><B>Parameters:</B><DD><CODE>text</CODE> - the bottom text.</DL>
1683	</DD>
1684	</DL>
1685	<HR>
1686
1687	<A NAME="setLinkoffline(java.lang.String)"><!-- --></A><H3>
1688	setLinkoffline</H3>
1689	<PRE>
1690	public void <B>setLinkoffline</B>(java.lang.String src)</PRE>
1691	<DL>
1692	<DD>Link to docs at "url" using package list at "url2"
1693	- separate the URLs by using a space character.
1694	<P>
1695	<DD><DL>
1696	<DT><B>Parameters:</B><DD><CODE>src</CODE> - the offline link specification (url and package list)</DL>
1697	</DD>
1698	</DL>
1699	<HR>
1700
1701	<A NAME="setGroup(java.lang.String)"><!-- --></A><H3>
1702	setGroup</H3>
1703	<PRE>
1704	public void <B>setGroup</B>(java.lang.String src)</PRE>
1705	<DL>
1706	<DD>Group specified packages together in overview page.
1707	<P>
1708	<DD><DL>
1709	<DT><B>Parameters:</B><DD><CODE>src</CODE> - the group packages - a command separated list of group specs,
1710	each one being a group name and package specification separated
1711	by a space.</DL>
1712	</DD>
1713	</DL>
1714	<HR>
1715
1716	<A NAME="setLink(java.lang.String)"><!-- --></A><H3>
1717	setLink</H3>
1718	<PRE>
1719	public void <B>setLink</B>(java.lang.String src)</PRE>
1720	<DL>
1721	<DD>Create links to javadoc output at the given URL.
1722	<P>
1723	<DD><DL>
1724	</DL>
1725	</DD>
1726	</DL>
1727	<HR>
1728
1729	<A NAME="setNodeprecated(boolean)"><!-- --></A><H3>
1730	setNodeprecated</H3>
1731	<PRE>
1732	public void <B>setNodeprecated</B>(boolean b)</PRE>
1733	<DL>
1734	<DD>Control deprecation infromation
1735	<P>
1736	<DD><DL>
1737	<DT><B>Parameters:</B><DD><CODE>b</CODE> - If true, do not include deprecated information.</DL>
1738	</DD>
1739	</DL>
1740	<HR>
1741
1742	<A NAME="setNodeprecatedlist(boolean)"><!-- --></A><H3>
1743	setNodeprecatedlist</H3>
1744	<PRE>
1745	public void <B>setNodeprecatedlist</B>(boolean b)</PRE>
1746	<DL>
1747	<DD>Control deprecated list generation
1748	<P>
1749	<DD><DL>
1750	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, do not generate deprecated list.</DL>
1751	</DD>
1752	</DL>
1753	<HR>
1754
1755	<A NAME="setNotree(boolean)"><!-- --></A><H3>
1756	setNotree</H3>
1757	<PRE>
1758	public void <B>setNotree</B>(boolean b)</PRE>
1759	<DL>
1760	<DD>Control class tree generation.
1761	<P>
1762	<DD><DL>
1763	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, do not generate class hierarchy.</DL>
1764	</DD>
1765	</DL>
1766	<HR>
1767
1768	<A NAME="setNoindex(boolean)"><!-- --></A><H3>
1769	setNoindex</H3>
1770	<PRE>
1771	public void <B>setNoindex</B>(boolean b)</PRE>
1772	<DL>
1773	<DD>Control generation of index.
1774	<P>
1775	<DD><DL>
1776	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, do not generate index.</DL>
1777	</DD>
1778	</DL>
1779	<HR>
1780
1781	<A NAME="setNohelp(boolean)"><!-- --></A><H3>
1782	setNohelp</H3>
1783	<PRE>
1784	public void <B>setNohelp</B>(boolean b)</PRE>
1785	<DL>
1786	<DD>Control generation of help link.
1787	<P>
1788	<DD><DL>
1789	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, do not generate help link</DL>
1790	</DD>
1791	</DL>
1792	<HR>
1793
1794	<A NAME="setNonavbar(boolean)"><!-- --></A><H3>
1795	setNonavbar</H3>
1796	<PRE>
1797	public void <B>setNonavbar</B>(boolean b)</PRE>
1798	<DL>
1799	<DD>Control generation of the navigation bar.
1800	<P>
1801	<DD><DL>
1802	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, do not generate navigation bar.</DL>
1803	</DD>
1804	</DL>
1805	<HR>
1806
1807	<A NAME="setSerialwarn(boolean)"><!-- --></A><H3>
1808	setSerialwarn</H3>
1809	<PRE>
1810	public void <B>setSerialwarn</B>(boolean b)</PRE>
1811	<DL>
1812	<DD>Control warnings about serial tag.
1813	<P>
1814	<DD><DL>
1815	<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true, generate warning about the serial tag.</DL>
1816	</DD>
1817	</DL>
1818	<HR>
1819
1820	<A NAME="setStylesheetfile(java.io.File)"><!-- --></A><H3>
1821	setStylesheetfile</H3>
1822	<PRE>
1823	public void <B>setStylesheetfile</B>(java.io.File f)</PRE>
1824	<DL>
1825	<DD>Specifies the CSS stylesheet file to use.
1826	<P>
1827	<DD><DL>
1828	<DT><B>Parameters:</B><DD><CODE>f</CODE> - the file with the CSS to use.</DL>
1829	</DD>
1830	</DL>
1831	<HR>
1832
1833	<A NAME="setHelpfile(java.io.File)"><!-- --></A><H3>
1834	setHelpfile</H3>
1835	<PRE>
1836	public void <B>setHelpfile</B>(java.io.File f)</PRE>
1837	<DL>
1838	<DD>Specifies the HTML help file to use.
1839	<P>
1840	<DD><DL>
1841	<DT><B>Parameters:</B><DD><CODE>f</CODE> - the file containing help content.</DL>
1842	</DD>
1843	</DL>
1844	<HR>
1845
1846	<A NAME="setDocencoding(java.lang.String)"><!-- --></A><H3>
1847	setDocencoding</H3>
1848	<PRE>
1849	public void <B>setDocencoding</B>(java.lang.String enc)</PRE>
1850	<DL>
1851	<DD>Output file encoding name.
1852	<P>
1853	<DD><DL>
1854	<DT><B>Parameters:</B><DD><CODE>enc</CODE> - name of the encoding to use.</DL>
1855	</DD>
1856	</DL>
1857	<HR>
1858
1859	<A NAME="setPackageList(java.lang.String)"><!-- --></A><H3>
1860	setPackageList</H3>
1861	<PRE>
1862	public void <B>setPackageList</B>(java.lang.String src)</PRE>
1863	<DL>
1864	<DD>The name of a file containing the packages to process.
1865	<P>
1866	<DD><DL>
1867	<DT><B>Parameters:</B><DD><CODE>src</CODE> - the file containing the package list.</DL>
1868	</DD>
1869	</DL>
1870	<HR>
1871
1872	<A NAME="createLink()"><!-- --></A><H3>
1873	createLink</H3>
1874	<PRE>
1875	public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.LinkArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.LinkArgument</A> <B>createLink</B>()</PRE>
1876	<DL>
1877	<DD>Create link to javadoc output at the given URL.
1878	<P>
1879	<DD><DL>
1880
1881	<DT><B>Returns:</B><DD>link argument to configure</DL>
1882	</DD>
1883	</DL>
1884	<HR>
1885
1886	<A NAME="createTag()"><!-- --></A><H3>
1887	createTag</H3>
1888	<PRE>
1889	public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.TagArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.TagArgument</A> <B>createTag</B>()</PRE>
1890	<DL>
1891	<DD>Creates and adds a -tag argument. This is used to specify
1892	custom tags. This argument is only available for JavaDoc 1.4,
1893	and will generate a verbose message (and then be ignored)
1894	when run on Java versions below 1.4.
1895	<P>
1896	<DD><DL>
1897	</DL>
1898	</DD>
1899	</DL>
1900	<HR>
1901
1902	<A NAME="createGroup()"><!-- --></A><H3>
1903	createGroup</H3>
1904	<PRE>
1905	public <A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.GroupArgument.html" title="class in org.apache.tools.ant.taskdefs">Javadoc.GroupArgument</A> <B>createGroup</B>()</PRE>
1906	<DL>
1907	<DD>Separates packages on the overview page into whatever
1908	groups you specify, one group per table.
1909	<P>
1910	<DD><DL>
1911	</DL>
1912	</DD>
1913	</DL>
1914	<HR>
1915
1916	<A NAME="setCharset(java.lang.String)"><!-- --></A><H3>
1917	setCharset</H3>
1918	<PRE>
1919	public void <B>setCharset</B>(java.lang.String src)</PRE>
1920	<DL>
1921	<DD>Charset for cross-platform viewing of generated documentation.
1922	<P>
1923	<DD><DL>
1924	</DL>
1925	</DD>
1926	</DL>
1927	<HR>
1928
1929	<A NAME="setFailonerror(boolean)"><!-- --></A><H3>
1930	setFailonerror</H3>
1931	<PRE>
1932	public void <B>setFailonerror</B>(boolean b)</PRE>
1933	<DL>
1934	<DD>Should the build process fail if javadoc fails (as indicated by
1935	a non zero return code)?
1936
1937	<p>Default is false.</p>
1938	<P>
1939	<DD><DL>
1940	</DL>
1941	</DD>
1942	</DL>
1943	<HR>
1944
1945	<A NAME="setSource(java.lang.String)"><!-- --></A><H3>
1946	setSource</H3>
1947	<PRE>
1948	public void <B>setSource</B>(java.lang.String source)</PRE>
1949	<DL>
1950	<DD>Enables the -source switch, will be ignored if javadoc is not
1951	the 1.4 version.
1952	<P>
1953	<DD><DL>
1954	<DT><B>Since:</B></DT>
1955	<DD>Ant 1.5</DD>
1956	</DL>
1957	</DD>
1958	</DL>
1959	<HR>
1960
1961	<A NAME="setExecutable(java.lang.String)"><!-- --></A><H3>
1962	setExecutable</H3>
1963	<PRE>
1964	public void <B>setExecutable</B>(java.lang.String executable)</PRE>
1965	<DL>
1966	<DD>Sets the actual executable command to invoke, instead of the binary
1967	<code>javadoc</code> found in Ant's JDK.
1968	<P>
1969	<DD><DL>
1970	<DT><B>Since:</B></DT>
1971	<DD>Ant 1.6.3</DD>
1972	</DL>
1973	</DD>
1974	</DL>
1975	<HR>
1976
1977	<A NAME="addPackageset(org.apache.tools.ant.types.DirSet)"><!-- --></A><H3>
1978	addPackageset</H3>
1979	<PRE>
1980	public void <B>addPackageset</B>(<A HREF="../../../../../org/apache/tools/ant/types/DirSet.html" title="class in org.apache.tools.ant.types">DirSet</A> packageSet)</PRE>
1981	<DL>
1982	<DD>Adds a packageset.
1983
1984	<p>All included directories will be translated into package
1985	names be converting the directory separator into dots.</p>
1986	<P>
1987	<DD><DL>
1988	<DT><B>Since:</B></DT>
1989	<DD>1.5</DD>
1990	</DL>
1991	</DD>
1992	</DL>
1993	<HR>
1994
1995	<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
1996	addFileset</H3>
1997	<PRE>
1998	public void <B>addFileset</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> fs)</PRE>
1999	<DL>
2000	<DD>Adds a fileset.
2001
2002	<p>All included files will be added as sourcefiles. The task
2003	will automatically add
2004	<code>includes="*/.java"</code> to the
2005	fileset.</p>
2006	<P>
2007	<DD><DL>
2008	<DT><B>Since:</B></DT>
2009	<DD>1.5</DD>
2010	</DL>
2011	</DD>
2012	</DL>
2013	<HR>
2014
2015	<A NAME="setLinksource(boolean)"><!-- --></A><H3>
2016	setLinksource</H3>
2017	<PRE>
2018	public void <B>setLinksource</B>(boolean b)</PRE>
2019	<DL>
2020	<DD>Enables the -linksource switch, will be ignored if javadoc is not
2021	the 1.4 version. Default is false
2022	<P>
2023	<DD><DL>
2024	<DT><B>Since:</B></DT>
2025	<DD>Ant 1.6</DD>
2026	</DL>
2027	</DD>
2028	</DL>
2029	<HR>
2030
2031	<A NAME="setBreakiterator(boolean)"><!-- --></A><H3>
2032	setBreakiterator</H3>
2033	<PRE>
2034	public void <B>setBreakiterator</B>(boolean b)</PRE>
2035	<DL>
2036	<DD>Enables the -linksource switch, will be ignored if javadoc is not
2037	the 1.4 version. Default is false
2038	<P>
2039	<DD><DL>
2040	<DT><B>Since:</B></DT>
2041	<DD>Ant 1.6</DD>
2042	</DL>
2043	</DD>
2044	</DL>
2045	<HR>
2046
2047	<A NAME="setNoqualifier(java.lang.String)"><!-- --></A><H3>
2048	setNoqualifier</H3>
2049	<PRE>
2050	public void <B>setNoqualifier</B>(java.lang.String noqualifier)</PRE>
2051	<DL>
2052	<DD>Enables the -noqualifier switch, will be ignored if javadoc is not
2053	the 1.4 version.
2054	<P>
2055	<DD><DL>
2056	<DT><B>Since:</B></DT>
2057	<DD>Ant 1.6</DD>
2058	</DL>
2059	</DD>
2060	</DL>
2061	<HR>
2062
2063	<A NAME="setIncludeNoSourcePackages(boolean)"><!-- --></A><H3>
2064	setIncludeNoSourcePackages</H3>
2065	<PRE>
2066	public void <B>setIncludeNoSourcePackages</B>(boolean b)</PRE>
2067	<DL>
2068	<DD>If set to true, Ant will also accept packages that only hold
2069	package.html files but no Java sources.
2070	<P>
2071	<DD><DL>
2072	<DT><B>Since:</B></DT>
2073	<DD>Ant 1.6.3</DD>
2074	</DL>
2075	</DD>
2076	</DL>
2077	<HR>
2078
2079	<A NAME="execute()"><!-- --></A><H3>
2080	execute</H3>
2081	<PRE>
2082	public void <B>execute</B>()
2083	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
2084	<DL>
2085	<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></B></DD>
2086	<DD>Called by the project to let the task do its work. This method may be
2087	called more than once, if the task is invoked more than once.
2088	For example,
2089	if target1 and target2 both depend on target3, then running
2090	"ant target1 target2" will run all tasks in target3 twice.
2091	<P>
2092	<DD><DL>
2093	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
2094	</DD>
2095	<DD><DL>
2096
2097	<DT><B>Throws:</B>
2098	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if something goes wrong with the build</DL>
2099	</DD>
2100	</DL>
2101	<HR>
2102
2103	<A NAME="expand(java.lang.String)"><!-- --></A><H3>
2104	expand</H3>
2105	<PRE>
2106	protected java.lang.String <B>expand</B>(java.lang.String content)</PRE>
2107	<DL>
2108	<DD>Convenience method to expand properties.
2109	<P>
2110	<DD><DL>
2111	</DL>
2112	</DD>
2113	</DL>
2114	<!-- ========= END OF CLASS DATA ========= -->
2115	<HR>
2116
2117
2118	<!-- ======= START OF BOTTOM NAVBAR ====== -->
2119	<A NAME="navbar_bottom"><!-- --></A>
2120	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
2121	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
2122	<TR>
2123	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
2124	<A NAME="navbar_bottom_firstrow"><!-- --></A>
2125	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
2126	<TR ALIGN="center" VALIGN="top">
2127	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
2128	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
2129	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
2130	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
2131	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
2132	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
2133	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
2134	</TR>
2135	</TABLE>
2136	</TD>
2137	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
2138	</EM>
2139	</TD>
2140	</TR>
2141
2142	<TR>
2143	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2144	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javac.ImplementationSpecificArgument.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
2145	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Javadoc.AccessType.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
2146	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2147	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
2148	<A HREF="Javadoc.html" target="_top"><B>NO FRAMES</B></A>
2149	<SCRIPT type="text/javascript">
2150	<!--
2151	if(window==top) {
2152	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
2153	}
2154	//-->
2155	</SCRIPT>
2156	<NOSCRIPT>
2157	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
2158	</NOSCRIPT>
2159
2160	</FONT></TD>
2161	</TR>
2162	<TR>
2163	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2164	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#fields_inherited_from_class_org.apache.tools.ant.Task">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
2165	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2166	DETAIL: FIELD \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
2167	</TR>
2168	</TABLE>
2169	<A NAME="skip-navbar_bottom"></A>
2170	<!-- ======== END OF BOTTOM NAVBAR ======= -->
2171
2172	<HR>
2173	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
2174	</BODY>
2175	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: