+++ /dev/null
-<?xml version="1.0" encoding="utf-8"?>\r
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"\r
- "DTD/xhtml1-transitional.dtd">\r
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
-<head>\r
- <title>Help</title>\r
- <link rel="stylesheet" href="epydoc.css" type="text/css" />\r
-<script type="text/javascript">\r
-<!--\r
-function setFrame(url1, url2){\r
- parent.frames[1].location.href = url1;\r
- parent.frames[2].location.href = url2;\r
-}\r
--->\r
-</script>\r
-</head>\r
-<body bgcolor="white" text="black" link="blue" vlink="#204080"\r
- alink="#204080">\r
-\r
-<!-- =========== START OF NAVBAR =========== -->\r
-<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
- <tr valign="middle">\r
- <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>\r
- <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>\r
- <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>\r
- <th bgcolor="#70b0f0" class="navselect"> Help </th>\r
- <th class="navbar" width="100%"></th>\r
- </tr>\r
-</table>\r
-<table width="100%" cellpadding="0" cellspacing="0">\r
- <tr valign="top">\r
- <td width="100%">\r
- </td>\r
- <td><table cellpadding="0" cellspacing="0">\r
- <tr><td align="right"><span class="options">[<a href="../private/help.html">show private</a> | hide private]</span></td></tr>\r
- <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
- </table></td>\r
-</tr></table>\r
-\r
-<h1 class="help"> API Documentation </h1>\r
-\r
-<p> This document contains the API (Application Programming Interface)\r
-documentation for this project. Documentation for the Python\r
-objects defined by the project is divided into separate pages for each\r
-package, module, and class. The API documentation also includes two\r
-pages containing information about the project as a whole: a trees\r
-page, and an index page. </p>\r
-\r
-<h2> Object Documentation </h2>\r
-\r
- <p>Each <strong>Package Documentation</strong> page contains: </p>\r
- <ul>\r
- <li> A description of the package. </li>\r
- <li> A list of the modules and sub-packages contained by the\r
- package. </li>\r
- <li> A summary of the classes defined by the package. </li>\r
- <li> A summary of the functions defined by the package. </li>\r
- <li> A summary of the variables defined by the package. </li>\r
- <li> A detailed description of each function defined by the\r
- package. </li>\r
- <li> A detailed description of each variable defined by the\r
- package. </li>\r
- </ul>\r
- \r
- <p>Each <strong>Module Documentation</strong> page contains:</p>\r
- <ul>\r
- <li> A description of the module. </li>\r
- <li> A summary of the classes defined by the module. </li>\r
- <li> A summary of the functions defined by the module. </li>\r
- <li> A summary of the variables defined by the module. </li>\r
- <li> A detailed description of each function defined by the\r
- module. </li>\r
- <li> A detailed description of each variable defined by the\r
- module. </li>\r
- </ul>\r
- \r
- <p>Each <strong>Class Documentation</strong> page contains: </p>\r
- <ul>\r
- <li> A class inheritance diagram. </li>\r
- <li> A list of known subclasses. </li>\r
- <li> A description of the class. </li>\r
- <li> A summary of the methods defined by the class. </li>\r
- <li> A summary of the instance variables defined by the class. </li>\r
- <li> A summary of the class (static) variables defined by the\r
- class. </li> \r
- <li> A detailed description of each method defined by the\r
- class. </li>\r
- <li> A detailed description of each instance variable defined by the\r
- class. </li> \r
- <li> A detailed description of each class (static) variable defined\r
- by the class. </li> \r
- </ul>\r
-\r
-<h2> Project Documentation </h2>\r
-\r
- <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p>\r
- <ul>\r
- <li> The <em>module hierarchy</em> lists every package and module, with\r
- modules grouped into packages. At the top level, and within each\r
- package, modules and sub-packages are listed alphabetically. </li>\r
- <li> The <em>class hierarchy</em> lists every class, grouped by base\r
- class. If a class has more than one base class, then it will be\r
- listed under each base class. At the top level, and under each base\r
- class, classes are listed alphabetically. </li>\r
- </ul>\r
- \r
- <p> The <strong>Index</strong> page contains indices of terms and\r
- identifiers: </p>\r
- <ul>\r
- <li> The <em>term index</em> lists every term indexed by any object's\r
- documentation. For each term, the index provides links to each\r
- place where the term is indexed. </li>\r
- <li> The <em>identifier index</em> lists the (short) name of every package,\r
- module, class, method, function, variable, and parameter. For each\r
- identifier, the index provides a short description, and a link to\r
- its documentation. </li>\r
- </ul>\r
-\r
-<h2> The Table of Contents </h2>\r
-\r
-<p> The table of contents occupies the two frames on the left side of\r
-the window. The upper-left frame displays the <em>project\r
-contents</em>, and the lower-left frame displays the <em>module\r
-contents</em>: </p>\r
-\r
-<table class="help summary" border="1" cellspacing="0" cellpadding="3">\r
- <tr style="height: 30%">\r
- <td align="center" style="font-size: small">\r
- Project<br />Contents<hr />...</td>\r
- <td align="center" style="font-size: small" rowspan="2" width="70%">\r
- API<br />Documentation<br />Frame<br /><br /><br />\r
- </td>\r
- </tr>\r
- <tr>\r
- <td align="center" style="font-size: small">\r
- Module<br />Contents<hr /> <br />...<br /> \r
- </td>\r
- </tr>\r
-</table><br />\r
-\r
-<p> The <strong>project contents frame</strong> contains a list of all packages\r
-and modules that are defined by the project. Clicking on an entry\r
-will display its contents in the module contents frame. Clicking on a\r
-special entry, labeled "Everything," will display the contents of\r
-the entire project. </p>\r
-\r
-<p> The <strong>module contents frame</strong> contains a list of every\r
-submodule, class, type, exception, function, and variable defined by a\r
-module or package. Clicking on an entry will display its\r
-documentation in the API documentation frame. Clicking on the name of\r
-the module, at the top of the frame, will display the documentation\r
-for the module itself. </p>\r
-\r
-<p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top\r
-navigation bar can be used to control whether the table of contents is\r
-displayed or not. </p>\r
-\r
-<h2> The Navigation Bar </h2>\r
-\r
-<p> A navigation bar is located at the top and bottom of every page.\r
-It indicates what type of page you are currently viewing, and allows\r
-you to go to related pages. The following table describes the labels\r
-on the navigation bar. Note that not some labels (such as\r
-[Parent]) are not displayed on all pages. </p>\r
-\r
-<table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">\r
-<tr class="summary">\r
- <th>Label</th>\r
- <th>Highlighted when...</th>\r
- <th>Links to...</th>\r
-</tr>\r
- <tr><td valign="top"><strong>[Parent]</strong></td>\r
- <td valign="top"><em>(never highlighted)</em></td>\r
- <td valign="top"> the parent of the current package </td></tr>\r
- <tr><td valign="top"><strong>[Package]</strong></td>\r
- <td valign="top">viewing a package</td>\r
- <td valign="top">the package containing the current object\r
- </td></tr>\r
- <tr><td valign="top"><strong>[Module]</strong></td>\r
- <td valign="top">viewing a module</td>\r
- <td valign="top">the module containing the current object\r
- </td></tr> \r
- <tr><td valign="top"><strong>[Class]</strong></td>\r
- <td valign="top">viewing a class </td>\r
- <td valign="top">the class containing the current object</td></tr>\r
- <tr><td valign="top"><strong>[Trees]</strong></td>\r
- <td valign="top">viewing the trees page</td>\r
- <td valign="top"> the trees page </td></tr>\r
- <tr><td valign="top"><strong>[Index]</strong></td>\r
- <td valign="top">viewing the index page</td>\r
- <td valign="top"> the index page </td></tr>\r
- <tr><td valign="top"><strong>[Help]</strong></td>\r
- <td valign="top">viewing the help page</td>\r
- <td valign="top"> the help page </td></tr>\r
-</table>\r
-\r
-<p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below\r
-the top navigation bar can be used to control whether documentation\r
-for private objects is displayed. Private objects are usually defined\r
-as objects whose (short) names begin with a single underscore, but do\r
-not end with an underscore. For example, "<code>_x</code>",\r
-"<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"\r
-are private objects; but "<code>re.sub</code>",\r
-"<code>__init__</code>", and "<code>type_</code>" are not. However,\r
-if a module defines the "<code>__all__</code>" variable, then its\r
-contents are used to decide which objects are private. </p>\r
-\r
-<p> A timestamp below the bottom navigation bar indicates when each\r
-page was last updated. </p>\r
-\r
-<!-- =========== START OF NAVBAR =========== -->\r
-<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">\r
- <tr valign="middle">\r
- <th class="navbar"> <a class="navbar" href="psycopg2-module.html">Home</a> </th>\r
- <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>\r
- <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>\r
- <th bgcolor="#70b0f0" class="navselect"> Help </th>\r
- <th class="navbar" width="100%"></th>\r
- </tr>\r
-</table>\r
-\r
-<table border="0" cellpadding="0" cellspacing="0" width="100%">\r
- <tr>\r
- <td align="left" class="footer">Generated by Epydoc 2.1 on Sat Jan 14 01:42:37 2006</td>\r
- <td align="right" class="footer">\r
- <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>\r
- </td>\r
- </tr>\r
-</table>\r
-</body>\r
-</html>\r
git://git.onelab.eu / plcapi.git / blobdiff