1 <?xml version="1.0" encoding="utf-8"?>
\r
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
\r
3 "DTD/xhtml1-transitional.dtd">
\r
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
\r
8 <script type="text/javascript">
\r
10 function setFrame(url1, url2){
\r
11 parent.frames[1].location.href = url1;
\r
12 parent.frames[2].location.href = url2;
\r
17 <body bgcolor="white" text="black" link="blue" vlink="#204080"
\r
20 <!-- =========== START OF NAVBAR =========== -->
\r
21 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
22 <tr valign="middle">
\r
23 <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
24 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
25 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
26 <th bgcolor="#70b0f0" class="navselect"> Help </th>
\r
27 <th class="navbar" width="100%"></th>
\r
30 <table width="100%" cellpadding="0" cellspacing="0">
\r
34 <td><table cellpadding="0" cellspacing="0">
\r
35 <tr><td align="right"><span class="options">[show private | <a href="../public/help.html">hide private</a>]</span></td></tr>
\r
36 <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</span></td></tr>
\r
40 <h1 class="help"> API Documentation </h1>
\r
42 <p> This document contains the API (Application Programming Interface)
\r
43 documentation for this project. Documentation for the Python
\r
44 objects defined by the project is divided into separate pages for each
\r
45 package, module, and class. The API documentation also includes two
\r
46 pages containing information about the project as a whole: a trees
\r
47 page, and an index page. </p>
\r
49 <h2> Object Documentation </h2>
\r
51 <p>Each <strong>Package Documentation</strong> page contains: </p>
\r
53 <li> A description of the package. </li>
\r
54 <li> A list of the modules and sub-packages contained by the
\r
56 <li> A summary of the classes defined by the package. </li>
\r
57 <li> A summary of the functions defined by the package. </li>
\r
58 <li> A summary of the variables defined by the package. </li>
\r
59 <li> A detailed description of each function defined by the
\r
61 <li> A detailed description of each variable defined by the
\r
65 <p>Each <strong>Module Documentation</strong> page contains:</p>
\r
67 <li> A description of the module. </li>
\r
68 <li> A summary of the classes defined by the module. </li>
\r
69 <li> A summary of the functions defined by the module. </li>
\r
70 <li> A summary of the variables defined by the module. </li>
\r
71 <li> A detailed description of each function defined by the
\r
73 <li> A detailed description of each variable defined by the
\r
77 <p>Each <strong>Class Documentation</strong> page contains: </p>
\r
79 <li> A class inheritance diagram. </li>
\r
80 <li> A list of known subclasses. </li>
\r
81 <li> A description of the class. </li>
\r
82 <li> A summary of the methods defined by the class. </li>
\r
83 <li> A summary of the instance variables defined by the class. </li>
\r
84 <li> A summary of the class (static) variables defined by the
\r
86 <li> A detailed description of each method defined by the
\r
88 <li> A detailed description of each instance variable defined by the
\r
90 <li> A detailed description of each class (static) variable defined
\r
91 by the class. </li>
\r
94 <h2> Project Documentation </h2>
\r
96 <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>
\r
98 <li> The <em>module hierarchy</em> lists every package and module, with
\r
99 modules grouped into packages. At the top level, and within each
\r
100 package, modules and sub-packages are listed alphabetically. </li>
\r
101 <li> The <em>class hierarchy</em> lists every class, grouped by base
\r
102 class. If a class has more than one base class, then it will be
\r
103 listed under each base class. At the top level, and under each base
\r
104 class, classes are listed alphabetically. </li>
\r
107 <p> The <strong>Index</strong> page contains indices of terms and
\r
110 <li> The <em>term index</em> lists every term indexed by any object's
\r
111 documentation. For each term, the index provides links to each
\r
112 place where the term is indexed. </li>
\r
113 <li> The <em>identifier index</em> lists the (short) name of every package,
\r
114 module, class, method, function, variable, and parameter. For each
\r
115 identifier, the index provides a short description, and a link to
\r
116 its documentation. </li>
\r
119 <h2> The Table of Contents </h2>
\r
121 <p> The table of contents occupies the two frames on the left side of
\r
122 the window. The upper-left frame displays the <em>project
\r
123 contents</em>, and the lower-left frame displays the <em>module
\r
124 contents</em>: </p>
\r
126 <table class="help summary" border="1" cellspacing="0" cellpadding="3">
\r
127 <tr style="height: 30%">
\r
128 <td align="center" style="font-size: small">
\r
129 Project<br />Contents<hr />...</td>
\r
130 <td align="center" style="font-size: small" rowspan="2" width="70%">
\r
131 API<br />Documentation<br />Frame<br /><br /><br />
\r
135 <td align="center" style="font-size: small">
\r
136 Module<br />Contents<hr /> <br />...<br />
\r
141 <p> The <strong>project contents frame</strong> contains a list of all packages
\r
142 and modules that are defined by the project. Clicking on an entry
\r
143 will display its contents in the module contents frame. Clicking on a
\r
144 special entry, labeled "Everything," will display the contents of
\r
145 the entire project. </p>
\r
147 <p> The <strong>module contents frame</strong> contains a list of every
\r
148 submodule, class, type, exception, function, and variable defined by a
\r
149 module or package. Clicking on an entry will display its
\r
150 documentation in the API documentation frame. Clicking on the name of
\r
151 the module, at the top of the frame, will display the documentation
\r
152 for the module itself. </p>
\r
154 <p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top
\r
155 navigation bar can be used to control whether the table of contents is
\r
156 displayed or not. </p>
\r
158 <h2> The Navigation Bar </h2>
\r
160 <p> A navigation bar is located at the top and bottom of every page.
\r
161 It indicates what type of page you are currently viewing, and allows
\r
162 you to go to related pages. The following table describes the labels
\r
163 on the navigation bar. Note that not some labels (such as
\r
164 [Parent]) are not displayed on all pages. </p>
\r
166 <table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
\r
167 <tr class="summary">
\r
169 <th>Highlighted when...</th>
\r
170 <th>Links to...</th>
\r
172 <tr><td valign="top"><strong>[Parent]</strong></td>
\r
173 <td valign="top"><em>(never highlighted)</em></td>
\r
174 <td valign="top"> the parent of the current package </td></tr>
\r
175 <tr><td valign="top"><strong>[Package]</strong></td>
\r
176 <td valign="top">viewing a package</td>
\r
177 <td valign="top">the package containing the current object
\r
179 <tr><td valign="top"><strong>[Module]</strong></td>
\r
180 <td valign="top">viewing a module</td>
\r
181 <td valign="top">the module containing the current object
\r
183 <tr><td valign="top"><strong>[Class]</strong></td>
\r
184 <td valign="top">viewing a class </td>
\r
185 <td valign="top">the class containing the current object</td></tr>
\r
186 <tr><td valign="top"><strong>[Trees]</strong></td>
\r
187 <td valign="top">viewing the trees page</td>
\r
188 <td valign="top"> the trees page </td></tr>
\r
189 <tr><td valign="top"><strong>[Index]</strong></td>
\r
190 <td valign="top">viewing the index page</td>
\r
191 <td valign="top"> the index page </td></tr>
\r
192 <tr><td valign="top"><strong>[Help]</strong></td>
\r
193 <td valign="top">viewing the help page</td>
\r
194 <td valign="top"> the help page </td></tr>
\r
197 <p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below
\r
198 the top navigation bar can be used to control whether documentation
\r
199 for private objects is displayed. Private objects are usually defined
\r
200 as objects whose (short) names begin with a single underscore, but do
\r
201 not end with an underscore. For example, "<code>_x</code>",
\r
202 "<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
\r
203 are private objects; but "<code>re.sub</code>",
\r
204 "<code>__init__</code>", and "<code>type_</code>" are not. However,
\r
205 if a module defines the "<code>__all__</code>" variable, then its
\r
206 contents are used to decide which objects are private. </p>
\r
208 <p> A timestamp below the bottom navigation bar indicates when each
\r
209 page was last updated. </p>
\r
211 <!-- =========== START OF NAVBAR =========== -->
\r
212 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
\r
213 <tr valign="middle">
\r
214 <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>
\r
215 <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
\r
216 <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
\r
217 <th bgcolor="#70b0f0" class="navselect"> Help </th>
\r
218 <th class="navbar" width="100%"></th>
\r
222 <table border="0" cellpadding="0" cellspacing="0" width="100%">
\r
224 <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:37 2006</td>
\r
225 <td align="right" class="footer">
\r
226 <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
\r
git://git.onelab.eu / plcapi.git / blob