source: TI05-delivery/trunk/doc/epydoc/private/help.html @ 1198

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI05-delivery/trunk/doc/epydoc/private/help.html@1198
Revision 1198, 10.0 KB checked in by spascoe, 13 years ago (diff)

Updated epydoc documentation.

Line 
1<?xml version="1.0" encoding="iso-8859-1"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3          "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6  <title>Help</title>
7  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8</head>
9<body bgcolor="white" text="black" link="blue" vlink="#204080"
10      alink="#204080">
11
12<!-- =========== START OF NAVBAR =========== -->
13<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14  <tr valign="center">
15    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18    <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
19    <th class="navbar" align="right" width="100%">
20      <table border="0" cellpadding="0" cellspacing="0">
21      <tr><th class="navbar" align="center">
22        <p class="nomargin">
23          NDG&nbsp;Delivery&nbsp;Service
24      </p></th></tr></table>
25    </th>
26  </tr>
27</table>
28<table width="100%" cellpadding="0" cellspacing="0">
29  <tr valign="top">
30    <td width="100%">
31    </td>
32    <td><table cellpadding="0" cellspacing="0">
33      <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/help.html">hide&nbsp;private</a>]</font></td></tr>
34      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="help.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
35    </table></td>
36</tr></table>
37
38<center><h2> API Documentation </h2></center>
39
40<p> This document contains the API (Application Programming Interface)
41documentation for NDG Delivery Service.  Documentation for the Python
42objects defined by the project is divided into separate pages for each
43package, module, and class.  The API documentation also includes two
44pages containing information about the project as a whole: a trees
45page, and an index page.  </p>
46
47<h2> Object Documentation </h2>
48
49  <p>Each <b>Package Documentation</b> page contains:
50  <ul>
51    <li> A description of the package. </li>
52    <li> A list of the modules and sub-packages contained by the
53    package.  </li>
54    <li> A summary of the classes defined by the package. </li>
55    <li> A summary of the functions defined by the package. </li>
56    <li> A summary of the variables defined by the package. </li>
57    <li> A detailed description of each function defined by the
58    package. </li>
59    <li> A detailed description of each variable defined by the
60    package. </li>
61  </ul></p>
62 
63  <p>Each <b>Module Documentation</b> page contains:
64  <ul>
65    <li> A description of the module. </li>
66    <li> A summary of the classes defined by the module. </li>
67    <li> A summary of the functions defined by the module. </li>
68    <li> A summary of the variables defined by the module. </li>
69    <li> A detailed description of each function defined by the
70    module. </li>
71    <li> A detailed description of each variable defined by the
72    module. </li>
73  </ul></p>
74 
75  <p>Each <b>Class Documentation</b> page contains:
76  <ul>
77    <li> A class inheritance diagram. </li>
78    <li> A list of known subclasses. </li>
79    <li> A description of the class. </li>
80    <li> A summary of the methods defined by the class. </li>
81    <li> A summary of the instance variables defined by the class. </li>
82    <li> A summary of the class (static) variables defined by the
83    class. </li> 
84    <li> A detailed description of each method defined by the
85    class. </li>
86    <li> A detailed description of each instance variable defined by the
87    class. </li> 
88    <li> A detailed description of each class (static) variable defined
89    by the class. </li> 
90  </ul></p>
91
92<h2> Project Documentation </h2>
93
94  <p> The <b>Trees</b> page contains the module and class hierarchies:
95  <ul>
96    <li> The <i>module hierarchy</i> lists every package and module, with
97    modules grouped into packages.  At the top level, and within each
98    package, modules and sub-packages are listed alphabetically. </li>
99    <li> The <i>class hierarchy</i> lists every class, grouped by base
100    class.  If a class has more than one base class, then it will be
101    listed under each base class.  At the top level, and under each base
102    class, classes are listed alphabetically. </li>
103  </ul></p>
104 
105  <p> The <b>Index</b> page contains indices of terms and
106  identifiers:
107  <ul>
108    <li> The <i>term index</i> lists every term indexed by any object's
109    documentation.  For each term, the index provides links to each
110    place where the term is indexed. </li>
111    <li> The <i>identifier index</i> lists the (short) name of every package,
112    module, class, method, function, variable, and parameter.  For each
113    identifier, the index provides a short description, and a link to
114    its documentation. </li>
115  </ul></p>
116
117<h2> The Table of Contents </h2>
118
119<p> The table of contents occupies the two frames on the left side of
120the window.  The upper-left frame displays the <i>project
121contents</i>, and the lower-left frame displays the <i>module
122contents</i>: </p>
123
124<center>
125<table class="summary" border="1" cellspacing="0" cellpadding="3">
126  <tr heigh="30%">
127    <td align="center">
128       <font size="-1">Project<br>Contents<hr>...</font></td>
129    <td align="center" rowspan="2" width="70%">
130      API<br>Documentation<br>Frame<br><br><br>
131    </td>
132  </tr>
133  <tr>
134    <td align="center">
135      <font size="-1">Module<br>Contents<hr>&nbsp;<br>...<br>&nbsp;</font>
136    </td>
137  </tr>
138</table><br>
139</center>
140
141<p> The <b>project contents frame</b> contains a list of all packages
142and modules that are defined by the project.  Clicking on an entry
143will display its contents in the module contents frame.  Clicking on a
144special entry, labeled "Everything," will display the contents of
145the entire project. </p>
146
147<p> The <b>module contents frame</b> contains a list of every
148submodule, class, type, exception, function, and variable defined by a
149module or package.  Clicking on an entry will display its
150documentation in the API documentation frame.  Clicking on the name of
151the module, at the top of the frame, will display the documentation
152for the module itself. </p>
153
154<p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top
155navigation bar can be used to control whether the table of contents is
156displayed or not. </p>
157
158<h2> The Navigation Bar </h2>
159
160<p> A navigation bar is located at the top and bottom of every page.
161It indicates what type of page you are currently viewing, and allows
162you to go to related pages.  The following table describes the labels
163on the navigation bar.  Note that not some labels (such as
164[Parent]) are not displayed on all pages. </p>
165
166<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
167<tr class="summary">
168  <th>Label</th>
169  <th>Highlighted when...</th>
170  <th>Links to...</th>
171</tr>
172  <tr><td valign="top"><b>[Parent]</b></td>
173      <td valign="top"><i>(never highlighted)</i></td>
174      <td valign="top"> the parent of the current package </td></tr>
175  <tr><td valign="top"><b>[Package]</b></td>
176      <td valign="top">viewing a package</td>
177      <td valign="top">the package containing the current object
178      </td></tr>
179  <tr><td valign="top"><b>[Module]</b></td>
180      <td valign="top">viewing a module</td>
181      <td valign="top">the module containing the current object
182      </td></tr> 
183  <tr><td valign="top"><b>[Class]</b></td>
184      <td valign="top">viewing a class </td>
185      <td valign="top">the class containing the current object</td></tr>
186  <tr><td valign="top"><b>[Trees]</b></td>
187      <td valign="top">viewing the trees page</td>
188      <td valign="top"> the trees page </td></tr>
189  <tr><td valign="top"><b>[Index]</b></td>
190      <td valign="top">viewing the index page</td>
191      <td valign="top"> the index page </td></tr>
192  <tr><td valign="top"><b>[Help]</b></td>
193      <td valign="top">viewing the help page</td>
194      <td valign="top"> the help page </td></tr>
195</table>
196
197<p> The "<b>show private</b>" and "<b>hide private</b>" buttons below
198the top navigation bar can be used to control whether documentation
199for private objects is displayed.  Private objects are usually defined
200as objects whose (short) names begin with a single underscore, but do
201not end with an underscore.  For example, "<code>_x</code>",
202"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
203are private objects; but "<code>re.sub</code>",
204"<code>__init__</code>", and "<code>type_</code>" are not.  However,
205if a module defines the "<code>__all__</code>" variable, then its
206contents are used to decide which objects are private. </p>
207
208<p> A timestamp below the bottom navigation bar indicates when each
209page was last updated. </p>
210
211<!-- =========== START OF NAVBAR =========== -->
212<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
213  <tr valign="center">
214    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="delivery-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
215    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
216    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
217    <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
218    <th class="navbar" align="right" width="100%">
219      <table border="0" cellpadding="0" cellspacing="0">
220      <tr><th class="navbar" align="center">
221        <p class="nomargin">
222          NDG&nbsp;Delivery&nbsp;Service
223      </p></th></tr></table>
224    </th>
225  </tr>
226</table>
227
228<table border="0" cellpadding="0" cellspacing="0" width="100%">
229  <tr>
230    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jun 15 15:59:14 2006</font></td>
231    <td align="right"><a href="http://epydoc.sourceforge.net"
232                      ><font size="-2">http://epydoc.sf.net</font></a></td>
233  </tr>
234</table>
235</body>
236</html>
Note: See TracBrowser for help on using the repository browser.