source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/help-doc.html@ 14982

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

initial import of LiRK3
File size: 8.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:36 NZST 2007 -->
6<TITLE>
7API Help (Apache Ant API)
8</TITLE>
9
10
11<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
12
13<SCRIPT type="text/javascript">
14function windowTitle()
15{
16 parent.document.title="API Help (Apache Ant API)";
17}
18</SCRIPT>
19
20</HEAD>
21
22<BODY BGCOLOR="white" onload="windowTitle();">
23
24
25<!-- ========= START OF TOP NAVBAR ======= -->
26<A NAME="navbar_top"><!-- --></A>
27<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
28<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
29<TR>
30<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
31<A NAME="navbar_top_firstrow"><!-- --></A>
32<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
33 <TR ALIGN="center" VALIGN="top">
34 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
41 </TR>
42</TABLE>
43</TD>
44<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
45</EM>
46</TD>
47</TR>
48
49<TR>
50<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
51&nbsp;PREV&nbsp;
52&nbsp;NEXT</FONT></TD>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 <A HREF="index.html" target="_top"><B>FRAMES</B></A> &nbsp;
55&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
56&nbsp;<SCRIPT type="text/javascript">
57 <!--
58 if(window==top) {
59 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
60 }
61 //-->
62</SCRIPT>
63<NOSCRIPT>
64 <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
65</NOSCRIPT>
66
67</FONT></TD>
68</TR>
69</TABLE>
70<A NAME="skip-navbar_top"></A>
71<!-- ========= END OF TOP NAVBAR ========= -->
72
73<HR>
74<CENTER>
75<H1>
76How This API Document Is Organized</H1>
77</CENTER>
78This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.<H3>
79Overview</H3>
80<BLOCKQUOTE>
81
82<P>
83The <A HREF="overview-summary.html">Overview</A> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</BLOCKQUOTE>
84<H3>
85Package</H3>
86<BLOCKQUOTE>
87
88<P>
89Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:<UL>
90<LI>Interfaces (italic)<LI>Classes<LI>Exceptions<LI>Errors</UL>
91</BLOCKQUOTE>
92<H3>
93Class/Interface</H3>
94<BLOCKQUOTE>
95
96<P>
97Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:<UL>
98<LI>Class inheritance diagram<LI>Direct Subclasses<LI>All Known Subinterfaces<LI>All Known Implementing Classes<LI>Class/interface declaration<LI>Class/interface description
99<P>
100<LI>Nested Class Summary<LI>Field Summary<LI>Constructor Summary<LI>Method Summary
101<P>
102<LI>Field Detail<LI>Constructor Detail<LI>Method Detail</UL>
103Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</BLOCKQUOTE>
104<H3>
105Tree (Class Hierarchy)</H3>
106<BLOCKQUOTE>
107There is a <A HREF="overview-tree.html">Class Hierarchy</A> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with <code>java.lang.Object</code>. The interfaces do not inherit from <code>java.lang.Object</code>.<UL>
108<LI>When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.<LI>When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.</UL>
109</BLOCKQUOTE>
110<H3>
111Deprecated API</H3>
112<BLOCKQUOTE>
113The <A HREF="deprecated-list.html">Deprecated API</A> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</BLOCKQUOTE>
114<H3>
115Index</H3>
116<BLOCKQUOTE>
117The <A HREF="index-all.html">Index</A> contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.</BLOCKQUOTE>
118<H3>
119Prev/Next</H3>
120These links take you to the next or previous class, interface, package, or related page.<H3>
121Frames/No Frames</H3>
122These links show and hide the HTML frames. All pages are available with or without frames.
123<P>
124<H3>
125Serialized Form</H3>
126Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
127<P>
128<FONT SIZE="-1">
129<EM>
130This help file applies to API documentation generated using the standard doclet.</EM>
131</FONT>
132<BR>
133<HR>
134
135
136<!-- ======= START OF BOTTOM NAVBAR ====== -->
137<A NAME="navbar_bottom"><!-- --></A>
138<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
139<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
140<TR>
141<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
142<A NAME="navbar_bottom_firstrow"><!-- --></A>
143<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
144 <TR ALIGN="center" VALIGN="top">
145 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
146 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
147 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
148 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
149 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
150 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
151 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Help</B></FONT>&nbsp;</TD>
152 </TR>
153</TABLE>
154</TD>
155<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
156</EM>
157</TD>
158</TR>
159
160<TR>
161<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
162&nbsp;PREV&nbsp;
163&nbsp;NEXT</FONT></TD>
164<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
165 <A HREF="index.html" target="_top"><B>FRAMES</B></A> &nbsp;
166&nbsp;<A HREF="help-doc.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
167&nbsp;<SCRIPT type="text/javascript">
168 <!--
169 if(window==top) {
170 document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
171 }
172 //-->
173</SCRIPT>
174<NOSCRIPT>
175 <A HREF="allclasses-noframe.html"><B>All Classes</B></A>
176</NOSCRIPT>
177
178</FONT></TD>
179</TR>
180</TABLE>
181<A NAME="skip-navbar_bottom"></A>
182<!-- ======== END OF BOTTOM NAVBAR ======= -->
183
184<HR>
185Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
186</BODY>
187</HTML>
Note: See TracBrowser for help on using the repository browser.