source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/StyleBook.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: 28.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:24 NZST 2007 -->
6<TITLE>
7StyleBook (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.StyleBook class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="StyleBook (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>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Script.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Test.html" title="class in org.apache.tools.ant.taskdefs.optional"><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> &nbsp;
56&nbsp;<A HREF="StyleBook.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
84org.apache.tools.ant.taskdefs.optional</FONT>
85<BR>
86Class StyleBook</H2>
87<PRE>
88java.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"><A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html" title="class in org.apache.tools.ant.taskdefs">org.apache.tools.ant.taskdefs.Java</A>
92 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.StyleBook</B>
93</PRE>
94<HR>
95<DL>
96<DT>public class <B>StyleBook</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html" title="class in org.apache.tools.ant.taskdefs">Java</A></DL>
97
98<P>
99Executes the Apache Stylebook documentation generator.
100 Unlike the commandline version of this tool, all three arguments
101 are required to run stylebook.
102 <p>
103 Being extended from &lt;Java&gt;, all the parent's attributes
104 and options are available. Do not set any apart from the <tt>classpath</tt>
105 as they are not guaranteed to be there in future.
106<P>
107
108<P>
109<DL>
110<DT><B>To do:</B></DT>
111 <DD>stop extending from Java.</DD>
112</DL>
113<HR>
114
115<P>
116<!-- ======== NESTED CLASS SUMMARY ======== -->
117
118
119<!-- =========== FIELD SUMMARY =========== -->
120
121<A NAME="field_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TD COLSPAN=2><FONT SIZE="+2">
125<B>Field Summary</B></FONT></TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>protected &nbsp;java.io.File</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#m_book">m_book</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#m_loaderConfig">m_loaderConfig</A></B></CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>protected &nbsp;java.io.File</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#m_skinDirectory">m_skinDirectory</A></B></CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>protected &nbsp;java.io.File</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#m_targetDirectory">m_targetDirectory</A></B></CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
158</TR>
159</TABLE>
160&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.Java"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
163<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html" title="class in org.apache.tools.ant.taskdefs">Java</A></B></TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#redirector">redirector</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#redirectorElement">redirectorElement</A></CODE></TD>
167</TR>
168</TABLE>
169&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
170<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
172<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>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<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>
176</TR>
177</TABLE>
178&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
181<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>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
185</TR>
186</TABLE>
187&nbsp;
188<!-- ======== CONSTRUCTOR SUMMARY ======== -->
189
190<A NAME="constructor_summary"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193<TD COLSPAN=2><FONT SIZE="+2">
194<B>Constructor Summary</B></FONT></TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#StyleBook()">StyleBook</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
201</TR>
202</TABLE>
203&nbsp;
204<!-- ========== METHOD SUMMARY =========== -->
205
206<A NAME="method_summary"><!-- --></A>
207<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
208<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
209<TD COLSPAN=2><FONT SIZE="+2">
210<B>Method Summary</B></FONT></TD>
211</TR>
212<TR BGCOLOR="white" CLASS="TableRowColor">
213<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214<CODE>&nbsp;void</CODE></FONT></TD>
215<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#execute()">execute</A></B>()</CODE>
216
217<BR>
218&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;call the program</TD>
219</TR>
220<TR BGCOLOR="white" CLASS="TableRowColor">
221<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222<CODE>&nbsp;void</CODE></FONT></TD>
223<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#setBook(java.io.File)">setBook</A></B>(java.io.File&nbsp;book)</CODE>
224
225<BR>
226&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The book xml file that the documentation generation starts from;
227 required.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>&nbsp;void</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#setLoaderConfig(java.lang.String)">setLoaderConfig</A></B>(java.lang.String&nbsp;loaderConfig)</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A loader configuration to send to stylebook; optional.</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;void</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#setSkinDirectory(java.io.File)">setSkinDirectory</A></B>(java.io.File&nbsp;skinDirectory)</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the directory that contains the stylebook skin;
244 required.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/StyleBook.html#setTargetDirectory(java.io.File)">setTargetDirectory</A></B>(java.io.File&nbsp;targetDirectory)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the destination directory where the documentation is generated;
253 required.</TD>
254</TR>
255</TABLE>
256&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.Java"><!-- --></A>
257<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
258<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
259<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.<A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html" title="class in org.apache.tools.ant.taskdefs">Java</A></B></TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#addAssertions(org.apache.tools.ant.types.Assertions)">addAssertions</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#addConfiguredRedirector(org.apache.tools.ant.types.RedirectorElement)">addConfiguredRedirector</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#addEnv(org.apache.tools.ant.types.Environment.Variable)">addEnv</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#addSysproperty(org.apache.tools.ant.types.Environment.Variable)">addSysproperty</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#addSyspropertyset(org.apache.tools.ant.types.PropertySet)">addSyspropertyset</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#clearArgs()">clearArgs</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createArg()">createArg</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createBootclasspath()">createBootclasspath</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createClasspath()">createClasspath</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createJvmarg()">createJvmarg</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createPermissions()">createPermissions</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#createWatchdog()">createWatchdog</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#executeJava()">executeJava</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#getCommandLine()">getCommandLine</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#getSysProperties()">getSysProperties</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#maybeSetResultPropertyValue(int)">maybeSetResultPropertyValue</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#run(java.lang.String, java.util.Vector)">run</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setAppend(boolean)">setAppend</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setArgs(java.lang.String)">setArgs</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setClassname(java.lang.String)">setClassname</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setDir(java.io.File)">setDir</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setError(java.io.File)">setError</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setErrorProperty(java.lang.String)">setErrorProperty</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setFailonerror(boolean)">setFailonerror</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setFork(boolean)">setFork</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setInput(java.io.File)">setInput</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setInputString(java.lang.String)">setInputString</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setJar(java.io.File)">setJar</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setJvm(java.lang.String)">setJvm</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setJvmargs(java.lang.String)">setJvmargs</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setJVMVersion(java.lang.String)">setJVMVersion</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setLogError(boolean)">setLogError</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setMaxmemory(java.lang.String)">setMaxmemory</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setNewenvironment(boolean)">setNewenvironment</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setOutput(java.io.File)">setOutput</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setOutputproperty(java.lang.String)">setOutputproperty</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setResultProperty(java.lang.String)">setResultProperty</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setSpawn(boolean)">setSpawn</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setTimeout(java.lang.Long)">setTimeout</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#setupRedirector()">setupRedirector</A></CODE></TD>
263</TR>
264</TABLE>
265&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
266<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
268<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>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<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#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>
272</TR>
273</TABLE>
274&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
275<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
276<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
277<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>
278</TR>
279<TR BGCOLOR="white" CLASS="TableRowColor">
280<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>
281</TR>
282</TABLE>
283&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
284<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
285<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
286<TD><B>Methods inherited from class java.lang.Object</B></TD>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
290</TR>
291</TABLE>
292&nbsp;
293<P>
294
295<!-- ============ FIELD DETAIL =========== -->
296
297<A NAME="field_detail"><!-- --></A>
298<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
299<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
300<TD COLSPAN=1><FONT SIZE="+2">
301<B>Field Detail</B></FONT></TD>
302</TR>
303</TABLE>
304
305<A NAME="m_targetDirectory"><!-- --></A><H3>
306m_targetDirectory</H3>
307<PRE>
308protected java.io.File <B>m_targetDirectory</B></PRE>
309<DL>
310<DL>
311</DL>
312</DL>
313<HR>
314
315<A NAME="m_skinDirectory"><!-- --></A><H3>
316m_skinDirectory</H3>
317<PRE>
318protected java.io.File <B>m_skinDirectory</B></PRE>
319<DL>
320<DL>
321</DL>
322</DL>
323<HR>
324
325<A NAME="m_loaderConfig"><!-- --></A><H3>
326m_loaderConfig</H3>
327<PRE>
328protected java.lang.String <B>m_loaderConfig</B></PRE>
329<DL>
330<DL>
331</DL>
332</DL>
333<HR>
334
335<A NAME="m_book"><!-- --></A><H3>
336m_book</H3>
337<PRE>
338protected java.io.File <B>m_book</B></PRE>
339<DL>
340<DL>
341</DL>
342</DL>
343
344<!-- ========= CONSTRUCTOR DETAIL ======== -->
345
346<A NAME="constructor_detail"><!-- --></A>
347<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
348<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
349<TD COLSPAN=1><FONT SIZE="+2">
350<B>Constructor Detail</B></FONT></TD>
351</TR>
352</TABLE>
353
354<A NAME="StyleBook()"><!-- --></A><H3>
355StyleBook</H3>
356<PRE>
357public <B>StyleBook</B>()</PRE>
358<DL>
359</DL>
360
361<!-- ============ METHOD DETAIL ========== -->
362
363<A NAME="method_detail"><!-- --></A>
364<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
365<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
366<TD COLSPAN=1><FONT SIZE="+2">
367<B>Method Detail</B></FONT></TD>
368</TR>
369</TABLE>
370
371<A NAME="setBook(java.io.File)"><!-- --></A><H3>
372setBook</H3>
373<PRE>
374public void <B>setBook</B>(java.io.File&nbsp;book)</PRE>
375<DL>
376<DD>The book xml file that the documentation generation starts from;
377 required.
378<P>
379<DD><DL>
380</DL>
381</DD>
382</DL>
383<HR>
384
385<A NAME="setSkinDirectory(java.io.File)"><!-- --></A><H3>
386setSkinDirectory</H3>
387<PRE>
388public void <B>setSkinDirectory</B>(java.io.File&nbsp;skinDirectory)</PRE>
389<DL>
390<DD>the directory that contains the stylebook skin;
391 required.
392<P>
393<DD><DL>
394</DL>
395</DD>
396</DL>
397<HR>
398
399<A NAME="setTargetDirectory(java.io.File)"><!-- --></A><H3>
400setTargetDirectory</H3>
401<PRE>
402public void <B>setTargetDirectory</B>(java.io.File&nbsp;targetDirectory)</PRE>
403<DL>
404<DD>the destination directory where the documentation is generated;
405 required.
406<P>
407<DD><DL>
408</DL>
409</DD>
410</DL>
411<HR>
412
413<A NAME="setLoaderConfig(java.lang.String)"><!-- --></A><H3>
414setLoaderConfig</H3>
415<PRE>
416public void <B>setLoaderConfig</B>(java.lang.String&nbsp;loaderConfig)</PRE>
417<DL>
418<DD>A loader configuration to send to stylebook; optional.
419<P>
420<DD><DL>
421</DL>
422</DD>
423</DL>
424<HR>
425
426<A NAME="execute()"><!-- --></A><H3>
427execute</H3>
428<PRE>
429public void <B>execute</B>()
430 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
431<DL>
432<DD>call the program
433<P>
434<DD><DL>
435<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/Java.html" title="class in org.apache.tools.ant.taskdefs">Java</A></CODE></DL>
436</DD>
437<DD><DL>
438
439<DT><B>Throws:</B>
440<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if failOnError is set to true and the application
441 returns a non 0 result code</DL>
442</DD>
443</DL>
444<!-- ========= END OF CLASS DATA ========= -->
445<HR>
446
447
448<!-- ======= START OF BOTTOM NAVBAR ====== -->
449<A NAME="navbar_bottom"><!-- --></A>
450<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
451<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
452<TR>
453<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
454<A NAME="navbar_bottom_firstrow"><!-- --></A>
455<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
456 <TR ALIGN="center" VALIGN="top">
457 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
458 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
459 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
460 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
461 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
462 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
463 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
464 </TR>
465</TABLE>
466</TD>
467<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
468</EM>
469</TD>
470</TR>
471
472<TR>
473<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
474&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Script.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>PREV CLASS</B></A>&nbsp;
475&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/Test.html" title="class in org.apache.tools.ant.taskdefs.optional"><B>NEXT CLASS</B></A></FONT></TD>
476<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
477 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
478&nbsp;<A HREF="StyleBook.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
479&nbsp;<SCRIPT type="text/javascript">
480 <!--
481 if(window==top) {
482 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
483 }
484 //-->
485</SCRIPT>
486<NOSCRIPT>
487 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
488</NOSCRIPT>
489
490</FONT></TD>
491</TR>
492<TR>
493<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
494 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
495<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
496DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
497</TR>
498</TABLE>
499<A NAME="skip-navbar_bottom"></A>
500<!-- ======== END OF BOTTOM NAVBAR ======= -->
501
502<HR>
503Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
504</BODY>
505</HTML>
Note: See TracBrowser for help on using the repository browser.