Mercurial > repos > yufei-luo > s_mart
comparison commons/pyRepetUnit/doc/help.html @ 18:94ab73e8a190
Uploaded
| author | m-zytnicki |
|---|---|
| date | Mon, 29 Apr 2013 03:20:15 -0400 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 17:b0e8584489e6 | 18:94ab73e8a190 |
|---|---|
| 1 <?xml version="1.0" encoding="ascii"?> | |
| 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" /> | |
| 8 <script type="text/javascript" src="epydoc.js"></script> | |
| 9 </head> | |
| 10 | |
| 11 <body bgcolor="white" text="black" link="blue" vlink="#204080" | |
| 12 alink="#204080"> | |
| 13 <!-- ==================== NAVIGATION BAR ==================== --> | |
| 14 <table class="navbar" border="0" width="100%" cellpadding="0" | |
| 15 bgcolor="#a0c0ff" cellspacing="0"> | |
| 16 <tr valign="middle"> | |
| 17 | |
| 18 <!-- Tree link --> | |
| 19 <th> <a | |
| 20 href="module-tree.html">Trees</a> </th> | |
| 21 | |
| 22 <!-- Index link --> | |
| 23 <th> <a | |
| 24 href="identifier-index.html">Indices</a> </th> | |
| 25 | |
| 26 <!-- Help link --> | |
| 27 <th bgcolor="#70b0f0" class="navbar-select" | |
| 28 > Help </th> | |
| 29 | |
| 30 <th class="navbar" width="100%"></th> | |
| 31 </tr> | |
| 32 </table> | |
| 33 <table width="100%" cellpadding="0" cellspacing="0"> | |
| 34 <tr valign="top"> | |
| 35 <td width="100%"> </td> | |
| 36 <td> | |
| 37 <table cellpadding="0" cellspacing="0"> | |
| 38 <!-- hide/show private --> | |
| 39 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" | |
| 40 onclick="toggle_private();">hide private</a>]</span></td></tr> | |
| 41 <tr><td align="right"><span class="options" | |
| 42 >[<a href="frames.html" target="_top">frames</a | |
| 43 >] | <a href="help.html" | |
| 44 target="_top">no frames</a>]</span></td></tr> | |
| 45 </table> | |
| 46 </td> | |
| 47 </tr> | |
| 48 </table> | |
| 49 | |
| 50 <h1 class="epydoc"> API Documentation </h1> | |
| 51 | |
| 52 <p> This document contains the API (Application Programming Interface) | |
| 53 documentation for this project. Documentation for the Python | |
| 54 objects defined by the project is divided into separate pages for each | |
| 55 package, module, and class. The API documentation also includes two | |
| 56 pages containing information about the project as a whole: a trees | |
| 57 page, and an index page. </p> | |
| 58 | |
| 59 <h2> Object Documentation </h2> | |
| 60 | |
| 61 <p>Each <strong>Package Documentation</strong> page contains: </p> | |
| 62 <ul> | |
| 63 <li> A description of the package. </li> | |
| 64 <li> A list of the modules and sub-packages contained by the | |
| 65 package. </li> | |
| 66 <li> A summary of the classes defined by the package. </li> | |
| 67 <li> A summary of the functions defined by the package. </li> | |
| 68 <li> A summary of the variables defined by the package. </li> | |
| 69 <li> A detailed description of each function defined by the | |
| 70 package. </li> | |
| 71 <li> A detailed description of each variable defined by the | |
| 72 package. </li> | |
| 73 </ul> | |
| 74 | |
| 75 <p>Each <strong>Module Documentation</strong> page contains:</p> | |
| 76 <ul> | |
| 77 <li> A description of the module. </li> | |
| 78 <li> A summary of the classes defined by the module. </li> | |
| 79 <li> A summary of the functions defined by the module. </li> | |
| 80 <li> A summary of the variables defined by the module. </li> | |
| 81 <li> A detailed description of each function defined by the | |
| 82 module. </li> | |
| 83 <li> A detailed description of each variable defined by the | |
| 84 module. </li> | |
| 85 </ul> | |
| 86 | |
| 87 <p>Each <strong>Class Documentation</strong> page contains: </p> | |
| 88 <ul> | |
| 89 <li> A class inheritance diagram. </li> | |
| 90 <li> A list of known subclasses. </li> | |
| 91 <li> A description of the class. </li> | |
| 92 <li> A summary of the methods defined by the class. </li> | |
| 93 <li> A summary of the instance variables defined by the class. </li> | |
| 94 <li> A summary of the class (static) variables defined by the | |
| 95 class. </li> | |
| 96 <li> A detailed description of each method defined by the | |
| 97 class. </li> | |
| 98 <li> A detailed description of each instance variable defined by the | |
| 99 class. </li> | |
| 100 <li> A detailed description of each class (static) variable defined | |
| 101 by the class. </li> | |
| 102 </ul> | |
| 103 | |
| 104 <h2> Project Documentation </h2> | |
| 105 | |
| 106 <p> The <strong>Trees</strong> page contains the module and class hierarchies: </p> | |
| 107 <ul> | |
| 108 <li> The <em>module hierarchy</em> lists every package and module, with | |
| 109 modules grouped into packages. At the top level, and within each | |
| 110 package, modules and sub-packages are listed alphabetically. </li> | |
| 111 <li> The <em>class hierarchy</em> lists every class, grouped by base | |
| 112 class. If a class has more than one base class, then it will be | |
| 113 listed under each base class. At the top level, and under each base | |
| 114 class, classes are listed alphabetically. </li> | |
| 115 </ul> | |
| 116 | |
| 117 <p> The <strong>Index</strong> page contains indices of terms and | |
| 118 identifiers: </p> | |
| 119 <ul> | |
| 120 <li> The <em>term index</em> lists every term indexed by any object's | |
| 121 documentation. For each term, the index provides links to each | |
| 122 place where the term is indexed. </li> | |
| 123 <li> The <em>identifier index</em> lists the (short) name of every package, | |
| 124 module, class, method, function, variable, and parameter. For each | |
| 125 identifier, the index provides a short description, and a link to | |
| 126 its documentation. </li> | |
| 127 </ul> | |
| 128 | |
| 129 <h2> The Table of Contents </h2> | |
| 130 | |
| 131 <p> The table of contents occupies the two frames on the left side of | |
| 132 the window. The upper-left frame displays the <em>project | |
| 133 contents</em>, and the lower-left frame displays the <em>module | |
| 134 contents</em>: </p> | |
| 135 | |
| 136 <table class="help summary" border="1" cellspacing="0" cellpadding="3"> | |
| 137 <tr style="height: 30%"> | |
| 138 <td align="center" style="font-size: small"> | |
| 139 Project<br />Contents<hr />...</td> | |
| 140 <td align="center" style="font-size: small" rowspan="2" width="70%"> | |
| 141 API<br />Documentation<br />Frame<br /><br /><br /> | |
| 142 </td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td align="center" style="font-size: small"> | |
| 146 Module<br />Contents<hr /> <br />...<br /> | |
| 147 </td> | |
| 148 </tr> | |
| 149 </table><br /> | |
| 150 | |
| 151 <p> The <strong>project contents frame</strong> contains a list of all packages | |
| 152 and modules that are defined by the project. Clicking on an entry | |
| 153 will display its contents in the module contents frame. Clicking on a | |
| 154 special entry, labeled "Everything," will display the contents of | |
| 155 the entire project. </p> | |
| 156 | |
| 157 <p> The <strong>module contents frame</strong> contains a list of every | |
| 158 submodule, class, type, exception, function, and variable defined by a | |
| 159 module or package. Clicking on an entry will display its | |
| 160 documentation in the API documentation frame. Clicking on the name of | |
| 161 the module, at the top of the frame, will display the documentation | |
| 162 for the module itself. </p> | |
| 163 | |
| 164 <p> The "<strong>frames</strong>" and "<strong>no frames</strong>" buttons below the top | |
| 165 navigation bar can be used to control whether the table of contents is | |
| 166 displayed or not. </p> | |
| 167 | |
| 168 <h2> The Navigation Bar </h2> | |
| 169 | |
| 170 <p> A navigation bar is located at the top and bottom of every page. | |
| 171 It indicates what type of page you are currently viewing, and allows | |
| 172 you to go to related pages. The following table describes the labels | |
| 173 on the navigation bar. Note that not some labels (such as | |
| 174 [Parent]) are not displayed on all pages. </p> | |
| 175 | |
| 176 <table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%"> | |
| 177 <tr class="summary"> | |
| 178 <th>Label</th> | |
| 179 <th>Highlighted when...</th> | |
| 180 <th>Links to...</th> | |
| 181 </tr> | |
| 182 <tr><td valign="top"><strong>[Parent]</strong></td> | |
| 183 <td valign="top"><em>(never highlighted)</em></td> | |
| 184 <td valign="top"> the parent of the current package </td></tr> | |
| 185 <tr><td valign="top"><strong>[Package]</strong></td> | |
| 186 <td valign="top">viewing a package</td> | |
| 187 <td valign="top">the package containing the current object | |
| 188 </td></tr> | |
| 189 <tr><td valign="top"><strong>[Module]</strong></td> | |
| 190 <td valign="top">viewing a module</td> | |
| 191 <td valign="top">the module containing the current object | |
| 192 </td></tr> | |
| 193 <tr><td valign="top"><strong>[Class]</strong></td> | |
| 194 <td valign="top">viewing a class </td> | |
| 195 <td valign="top">the class containing the current object</td></tr> | |
| 196 <tr><td valign="top"><strong>[Trees]</strong></td> | |
| 197 <td valign="top">viewing the trees page</td> | |
| 198 <td valign="top"> the trees page </td></tr> | |
| 199 <tr><td valign="top"><strong>[Index]</strong></td> | |
| 200 <td valign="top">viewing the index page</td> | |
| 201 <td valign="top"> the index page </td></tr> | |
| 202 <tr><td valign="top"><strong>[Help]</strong></td> | |
| 203 <td valign="top">viewing the help page</td> | |
| 204 <td valign="top"> the help page </td></tr> | |
| 205 </table> | |
| 206 | |
| 207 <p> The "<strong>show private</strong>" and "<strong>hide private</strong>" buttons below | |
| 208 the top navigation bar can be used to control whether documentation | |
| 209 for private objects is displayed. Private objects are usually defined | |
| 210 as objects whose (short) names begin with a single underscore, but do | |
| 211 not end with an underscore. For example, "<code>_x</code>", | |
| 212 "<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>" | |
| 213 are private objects; but "<code>re.sub</code>", | |
| 214 "<code>__init__</code>", and "<code>type_</code>" are not. However, | |
| 215 if a module defines the "<code>__all__</code>" variable, then its | |
| 216 contents are used to decide which objects are private. </p> | |
| 217 | |
| 218 <p> A timestamp below the bottom navigation bar indicates when each | |
| 219 page was last updated. </p> | |
| 220 <!-- ==================== NAVIGATION BAR ==================== --> | |
| 221 <table class="navbar" border="0" width="100%" cellpadding="0" | |
| 222 bgcolor="#a0c0ff" cellspacing="0"> | |
| 223 <tr valign="middle"> | |
| 224 | |
| 225 <!-- Tree link --> | |
| 226 <th> <a | |
| 227 href="module-tree.html">Trees</a> </th> | |
| 228 | |
| 229 <!-- Index link --> | |
| 230 <th> <a | |
| 231 href="identifier-index.html">Indices</a> </th> | |
| 232 | |
| 233 <!-- Help link --> | |
| 234 <th bgcolor="#70b0f0" class="navbar-select" | |
| 235 > Help </th> | |
| 236 | |
| 237 <th class="navbar" width="100%"></th> | |
| 238 </tr> | |
| 239 </table> | |
| 240 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> | |
| 241 <tr> | |
| 242 <td align="left" class="footer"> | |
| 243 Generated by Epydoc 3.0.1 on Fri Apr 10 16:39:01 2009 | |
| 244 </td> | |
| 245 <td align="right" class="footer"> | |
| 246 <a target="mainFrame" href="http://epydoc.sourceforge.net" | |
| 247 >http://epydoc.sourceforge.net</a> | |
| 248 </td> | |
| 249 </tr> | |
| 250 </table> | |
| 251 | |
| 252 <script type="text/javascript"> | |
| 253 <!-- | |
| 254 // Private objects are initially displayed (because if | |
| 255 // javascript is turned off then we want them to be | |
| 256 // visible); but by default, we want to hide them. So hide | |
| 257 // them unless we have a cookie that says to show them. | |
| 258 checkCookie(); | |
| 259 // --> | |
| 260 </script> | |
| 261 </body> | |
| 262 </html> |