?? help.html
字號:
<?xml version="1.0" encoding="iso-8859-1"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head> <title>Help</title> <link rel="stylesheet" href="epydoc.css" type="text/css"></link></head><body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"><!-- =========== START OF NAVBAR =========== --><table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="center"> <th class="navbar"> <a class="navbar" href="netconv-module.html">Home</a> </th> <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> <th bgcolor="#70b0f0" class="navselect"> Help </th> <th class="navbar" width="100%"></th> </tr></table><table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> </td> <td><table cellpadding="0" cellspacing="0"> <tr><td align="right"><font size="-2">[show private | <a href="../public/help.html">hide private</a>]</font></td></tr> <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="help.html" target="_top">no frames</a>]</font></td></tr> </table></td></tr></table><center><h2> API Documentation </h2></center><p> This document contains the API (Application Programming Interface)documentation for this project. Documentation for the Pythonobjects defined by the project is divided into separate pages for eachpackage, module, and class. The API documentation also includes twopages containing information about the project as a whole: a treespage, and an index page. </p><h2> Object Documentation </h2> <p>Each <b>Package Documentation</b> page contains: <ul> <li> A description of the package. </li> <li> A list of the modules and sub-packages contained by the package. </li> <li> A summary of the classes defined by the package. </li> <li> A summary of the functions defined by the package. </li> <li> A summary of the variables defined by the package. </li> <li> A detailed description of each function defined by the package. </li> <li> A detailed description of each variable defined by the package. </li> </ul></p> <p>Each <b>Module Documentation</b> page contains: <ul> <li> A description of the module. </li> <li> A summary of the classes defined by the module. </li> <li> A summary of the functions defined by the module. </li> <li> A summary of the variables defined by the module. </li> <li> A detailed description of each function defined by the module. </li> <li> A detailed description of each variable defined by the module. </li> </ul></p> <p>Each <b>Class Documentation</b> page contains: <ul> <li> A class inheritance diagram. </li> <li> A list of known subclasses. </li> <li> A description of the class. </li> <li> A summary of the methods defined by the class. </li> <li> A summary of the instance variables defined by the class. </li> <li> A summary of the class (static) variables defined by the class. </li> <li> A detailed description of each method defined by the class. </li> <li> A detailed description of each instance variable defined by the class. </li> <li> A detailed description of each class (static) variable defined by the class. </li> </ul></p><h2> Project Documentation </h2> <p> The <b>Trees</b> page contains the module and class hierarchies: <ul> <li> The <i>module hierarchy</i> lists every package and module, with modules grouped into packages. At the top level, and within each package, modules and sub-packages are listed alphabetically. </li> <li> The <i>class hierarchy</i> lists every class, grouped by base class. If a class has more than one base class, then it will be listed under each base class. At the top level, and under each base class, classes are listed alphabetically. </li> </ul></p> <p> The <b>Index</b> page contains indices of terms and identifiers: <ul> <li> The <i>term index</i> lists every term indexed by any object's documentation. For each term, the index provides links to each place where the term is indexed. </li> <li> The <i>identifier index</i> lists the (short) name of every package, module, class, method, function, variable, and parameter. For each identifier, the index provides a short description, and a link to its documentation. </li> </ul></p><h2> The Table of Contents </h2><p> The table of contents occupies the two frames on the left side ofthe window. The upper-left frame displays the <i>projectcontents</i>, and the lower-left frame displays the <i>modulecontents</i>: </p><center><table class="summary" border="1" cellspacing="0" cellpadding="3"> <tr heigh="30%"> <td align="center"> <font size="-1">Project<br>Contents<hr>...</font></td> <td align="center" rowspan="2" width="70%"> API<br>Documentation<br>Frame<br><br><br> </td> </tr> <tr> <td align="center"> <font size="-1">Module<br>Contents<hr> <br>...<br> </font> </td> </tr></table><br></center><p> The <b>project contents frame</b> contains a list of all packagesand modules that are defined by the project. Clicking on an entrywill display its contents in the module contents frame. Clicking on aspecial entry, labeled "Everything," will display the contents ofthe entire project. </p><p> The <b>module contents frame</b> contains a list of everysubmodule, class, type, exception, function, and variable defined by amodule or package. Clicking on an entry will display itsdocumentation in the API documentation frame. Clicking on the name ofthe module, at the top of the frame, will display the documentationfor the module itself. </p><p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the topnavigation bar can be used to control whether the table of contents isdisplayed or not. </p><h2> The Navigation Bar </h2><p> A navigation bar is located at the top and bottom of every page.It indicates what type of page you are currently viewing, and allowsyou to go to related pages. The following table describes the labelson the navigation bar. Note that not some labels (such as[Parent]) are not displayed on all pages. </p><table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%"><tr class="summary"> <th>Label</th> <th>Highlighted when...</th> <th>Links to...</th></tr> <tr><td valign="top"><b>[Parent]</b></td> <td valign="top"><i>(never highlighted)</i></td> <td valign="top"> the parent of the current package </td></tr> <tr><td valign="top"><b>[Package]</b></td> <td valign="top">viewing a package</td> <td valign="top">the package containing the current object </td></tr> <tr><td valign="top"><b>[Module]</b></td> <td valign="top">viewing a module</td> <td valign="top">the module containing the current object </td></tr> <tr><td valign="top"><b>[Class]</b></td> <td valign="top">viewing a class </td> <td valign="top">the class containing the current object</td></tr> <tr><td valign="top"><b>[Trees]</b></td> <td valign="top">viewing the trees page</td> <td valign="top"> the trees page </td></tr> <tr><td valign="top"><b>[Index]</b></td> <td valign="top">viewing the index page</td> <td valign="top"> the index page </td></tr> <tr><td valign="top"><b>[Help]</b></td> <td valign="top">viewing the help page</td> <td valign="top"> the help page </td></tr></table><p> The "<b>show private</b>" and "<b>hide private</b>" buttons belowthe top navigation bar can be used to control whether documentationfor private objects is displayed. Private objects are usually definedas objects whose (short) names begin with a single underscore, but donot end with an underscore. For example, "<code>_x</code>","<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"are private objects; but "<code>re.sub</code>","<code>__init__</code>", and "<code>type_</code>" are not. However,if a module defines the "<code>__all__</code>" variable, then itscontents are used to decide which objects are private. </p><p> A timestamp below the bottom navigation bar indicates when eachpage was last updated. </p><!-- =========== START OF NAVBAR =========== --><table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="center"> <th class="navbar"> <a class="navbar" href="netconv-module.html">Home</a> </th> <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> <th bgcolor="#70b0f0" class="navselect"> Help </th> <th class="navbar" width="100%"></th> </tr></table><table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Aug 30 11:04:16 2005</font></td> <td align="right"><a href="http://epydoc.sourceforge.net" ><font size="-2">http://epydoc.sf.net</font></a></td> </tr></table></body></html>?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -