www/python_reference/help.html

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