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