<?xml version="1.0" encoding="ascii"?>
<!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>epydoc.docparser</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
Module docparser
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.docparser-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module docparser</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.docparser-pysrc.html">source code</a></span></p>
<p>Extract API documentation about python objects by parsing their source
code.</p>
<p>The function <a href="epydoc.docparser-module.html#parse_docs"
class="link">parse_docs()</a>, which provides the main interface of this
module, reads and parses the Python source code for a module, and uses it
to create an <a href="epydoc.apidoc.APIDoc-class.html"
class="link">APIDoc</a> object containing the API documentation for the
variables and values defined in that modules.</p>
<p>Currently, <code>parse_docs()</code> extracts documentation from the
following source code constructions:</p>
<ul>
<li>
module docstring
</li>
<li>
import statements
</li>
<li>
class definition blocks
</li>
<li>
function definition blocks
</li>
<li>
assignment statements
<ul>
<li>
simple assignment statements
</li>
<li>
assignment statements with multiple <code>'='</code>s
</li>
<li>
assignment statements with unpacked left-hand sides
</li>
<li>
assignment statements that wrap a function in classmethod or
staticmethod.
</li>
<li>
assignment to special variables __path__, __all__, and
__docformat__.
</li>
</ul>
</li>
<li>
delete statements
</li>
</ul>
<p><code>parse_docs()</code> does not yet support the following source
code constructions:</p>
<ul>
<li>
assignment statements that create properties
</li>
</ul>
<p>By default, <code>parse_docs()</code> will expore the contents of
top-level <code>try</code> and <code>if</code> blocks. If desired,
<code>parse_docs()</code> can also be configured to explore the contents
of <code>while</code> and <code>for</code> blocks. (See the configuration
constants, below.)</p>
<hr />
<div class="fields"> <p><strong>To Do:</strong>
Make it possible to extend the functionality of
<code>parse_docs()</code>, by replacing process_line with a dispatch
table that can be customized (similarly to
<code>docintrospector.register_introspector()</code>).
</p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser.ParseError-class.html" class="summary-name">ParseError</a><br />
An exception that is used to signify that <code>docparser</code>
encountered syntactically invalid Python code while processing a
Python source file.
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Module parser</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.apidoc.ValueDoc-class.html" class="link">ValueDoc</a></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_docs" class="summary-sig-name">parse_docs</a>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">name</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">is_script</span>=<span class="summary-sig-default">False</span>)</span><br />
Generate the API documentation for a specified object by parsing
Python source files, and return it as a <a
href="epydoc.apidoc.ValueDoc-class.html" class="link">ValueDoc</a>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_docs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docs-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_docs-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docs" name="call_graph_for_parse_docs">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="571,62,821,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="560,118,832,150" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="docbuilder._get_docs_from_module_file()" alt="" coords="5,202,344,234" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="393,230,511,262" />
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_docs" title="docintrospecter.introspect_docs()" alt="" coords="561,174,831,206" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="659,6,733,38" />
<area shape="rect" href="epydoc.docparser-module.html#_get_module_name" title="_get_module_name()" alt="" coords="605,230,787,262" />
<area shape="rect" href="epydoc.docparser-module.html#_parse_package" title="_parse_package()" alt="" coords="619,286,773,318" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="121,258,228,290" />
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="571,342,821,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="633,398,759,430" />
<area shape="rect" href="epydoc.log-module.html#info" title="log.info()" alt="" coords="651,454,741,486" />
<area shape="rect" href="epydoc.util-module.html#py_src_filename" title="util.py_src_filename()" alt="" coords="601,510,791,542" />
</map>
<img src="call_graph_for_parse_docs.gif" alt='' usemap="#call_graph_for_parse_docs" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_parse_package"></a><span class="summary-sig-name">_parse_package</span>(<span class="summary-sig-arg">package_dir</span>)</span><br />
If the given directory is a package directory, then parse its
__init__.py file (and the __init__.py files of all ancestor
packages); and return its <code>ModuleDoc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_parse_package">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__parse_package-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__parse_package-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__parse_package" name="call_graph_for__parse_package">
<area shape="rect" href="epydoc.docparser-module.html#_parse_package" title="_parse_package()" alt="" coords="173,6,328,38" />
<area shape="rect" href="epydoc.util-module.html#is_package_dir" title="util.is_package_dir()" alt="" coords="377,6,553,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="7,6,124,38" />
</map>
<img src="call_graph_for__parse_package.gif" alt='' usemap="#call_graph_for__parse_package" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="handle_special_module_vars"></a><span class="summary-sig-name">handle_special_module_vars</span>(<span class="summary-sig-arg">module_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#handle_special_module_vars">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_handle_special_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_handle_special_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_handle_special_" name="call_graph_for_handle_special_">
<area shape="rect" href="epydoc.docparser-module.html#_module_var_toktree" title="_module_var_toktree()" alt="" coords="475,6,670,38" />
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="175,62,426,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string" title="parse_string()" alt="" coords="510,62,635,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string_list" title="parse_string_list()" alt="" coords="494,118,651,150" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="7,62,124,94" />
</map>
<img src="call_graph_for_handle_special_.gif" alt='' usemap="#call_graph_for_handle_special_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_module_var_toktree"></a><span class="summary-sig-name">_module_var_toktree</span>(<span class="summary-sig-arg">module_doc</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_module_var_toktree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__module_var_tok-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__module_var_tok-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__module_var_tok" name="call_graph_for__module_var_tok">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="550,6,774,38" />
<area shape="rect" href="epydoc.docparser-module.html#_module_var_toktree" title="_module_var_toktree()" alt="" coords="307,6,502,38" />
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="7,6,258,38" />
</map>
<img src="call_graph_for__module_var_tok.gif" alt='' usemap="#call_graph_for__module_var_tok" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" class="private">
<th colspan="2" class="group-header"
> Module Lookup</th></tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#_find" class="summary-sig-name" onclick="show_private();">_find</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">package_doc</span>=<span class="summary-sig-default">None</span>)</span><br />
Return the API documentaiton for the object whose name is
<code>name</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_find">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__find-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__find-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__find" name="call_graph_for__find">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="409,6,689,38" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="285,146,360,178" />
<area shape="rect" href="epydoc.docparser-module.html#_find_in_namespace" title="_find_in_namespace()" alt="" coords="455,62,644,94" />
<area shape="rect" href="epydoc.docparser-module.html#_get_filename" title="_get_filename()" alt="" coords="479,118,620,150" />
<area shape="rect" href="epydoc.docparser-module.html#_is_submodule_import_var" title="_is_submodule_import_var()" alt="" coords="429,174,669,206" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="491,230,608,262" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="5,146,237,178" />
</map>
<img src="call_graph_for__find.gif" alt='' usemap="#call_graph_for__find" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#_is_submodule_import_var" class="summary-sig-name" onclick="show_private();">_is_submodule_import_var</a>(<span class="summary-sig-arg">module_doc</span>,
<span class="summary-sig-arg">var_name</span>)</span><br />
Return true if <code>var_name</code> is the name of a variable in
<code>module_doc</code> that just contains an
<code>imported_from</code> link to a submodule of the same name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_is_submodule_import_var">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__is_submodule_i-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__is_submodule_i-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__is_submodule_i" name="call_graph_for__is_submodule_i">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="417,6,673,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="420,62,671,94" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="5,34,80,66" />
<area shape="rect" href="epydoc.docparser-module.html#_is_submodule_import_var" title="_is_submodule_import_var()" alt="" coords="128,34,368,66" />
</map>
<img src="call_graph_for__is_submodule_i.gif" alt='' usemap="#call_graph_for__is_submodule_i" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_find_in_namespace"></a><span class="summary-sig-name">_find_in_namespace</span>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">namespace_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_find_in_namespace">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__find_in_namesp-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__find_in_namesp-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__find_in_namesp" name="call_graph_for__find_in_namesp">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="367,6,647,38" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="5,6,80,38" />
<area shape="rect" href="epydoc.docparser-module.html#_find_in_namespace" title="_find_in_namespace()" alt="" coords="128,6,317,38" />
</map>
<img src="call_graph_for__find_in_namesp.gif" alt='' usemap="#call_graph_for__find_in_namesp" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get_filename"></a><span class="summary-sig-name">_get_filename</span>(<span class="summary-sig-arg">identifier</span>,
<span class="summary-sig-arg">path</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_get_filename">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get_filename-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__get_filename-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__get_filename" name="call_graph_for__get_filename">
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="6,6,80,38" />
<area shape="rect" href="epydoc.docparser-module.html#_get_filename" title="_get_filename()" alt="" coords="128,6,270,38" />
</map>
<img src="call_graph_for__get_filename.gif" alt='' usemap="#call_graph_for__get_filename" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> File tokenization loop</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_file" class="summary-sig-name">process_file</a>(<span class="summary-sig-arg">module_doc</span>)</span><br />
Read the given <code>ModuleDoc</code>'s file, and add variables
corresponding to any objects defined in that file.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_file">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_file-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_file-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_file" name="call_graph_for_process_file">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="383,6,607,38" />
<area shape="rect" href="epydoc.docparser-module.html#add_to_group" title="add_to_group()" alt="" coords="427,62,563,94" />
<area shape="rect" href="epydoc.docparser-module.html#get_module_encoding" title="get_module_encoding()" alt="" coords="395,118,595,150" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="7,146,124,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="173,146,299,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="431,174,559,206" />
<area shape="rect" href="epydoc.docparser-module.html#shallow_parse" title="shallow_parse()" alt="" coords="424,230,565,262" />
<area shape="rect" href="epydoc.util-module.html#decode_with_backslashreplace" title="util.decode_with_backslashreplace()" alt="" coords="347,286,643,318" />
</map>
<img src="call_graph_for_process_file.gif" alt='' usemap="#call_graph_for_process_file" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="add_to_group"></a><span class="summary-sig-name">add_to_group</span>(<span class="summary-sig-arg">container</span>,
<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">group_name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#add_to_group">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_add_to_group-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_add_to_group-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_add_to_group" name="call_graph_for_add_to_group">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="367,6,647,38" />
<area shape="rect" href="epydoc.docparser-module.html#add_to_group" title="add_to_group()" alt="" coords="180,6,316,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,6,131,38" />
</map>
<img src="call_graph_for_add_to_group.gif" alt='' usemap="#call_graph_for_add_to_group" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="script_guard"></a><span class="summary-sig-name">script_guard</span>(<span class="summary-sig-arg">line</span>)</span><br />
Detect the idiomatic trick <code>if __name__ ==
"__main__":</code></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#script_guard">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_script_guard-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_script_guard-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_script_guard" name="call_graph_for_script_guard">
<area shape="rect" href="epydoc.docparser-module.html#process_control_flow_line" title="process_control_flow_line()" alt="" coords="7,6,239,38" />
<area shape="rect" href="epydoc.docparser-module.html#script_guard" title="script_guard()" alt="" coords="289,6,415,38" />
</map>
<img src="call_graph_for_script_guard.gif" alt='' usemap="#call_graph_for_script_guard" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Shallow parser</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#shallow_parse" class="summary-sig-name">shallow_parse</a>(<span class="summary-sig-arg">line_toks</span>)</span><br />
Given a flat list of tokens, return a nested tree structure (called a
<a name="index-token_tree"></a><i class="indexterm">token tree</i>),
whose leaves are identical to the original list, but whose structure
reflects the structure implied by the grouping tokens (i.e.,
parenthases, braces, and brackets).</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#shallow_parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_shallow_parse-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_shallow_parse-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_shallow_parse" name="call_graph_for_shallow_parse">
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,6,131,38" />
<area shape="rect" href="epydoc.docparser-module.html#shallow_parse" title="shallow_parse()" alt="" coords="179,6,320,38" />
</map>
<img src="call_graph_for_shallow_parse.gif" alt='' usemap="#call_graph_for_shallow_parse" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Line processing</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_line" class="summary-sig-name">process_line</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
Returns:
<code>new-doc</code>, <code>decorator</code>..?</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_line">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_line-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_line-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_line" name="call_graph_for_process_line">
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="383,6,567,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="395,62,555,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_control_flow_line" title="process_control_flow_line()" alt="" coords="359,118,591,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="413,174,536,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="389,230,560,262" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,314,131,346" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="180,314,308,346" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="377,286,572,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="396,342,553,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="400,398,549,430" />
<area shape="rect" href="epydoc.docparser-module.html#process_multi_stmt" title="process_multi_stmt()" alt="" coords="384,454,565,486" />
<area shape="rect" href="epydoc.docparser-module.html#process_one_line_block" title="process_one_line_block()" alt="" coords="367,510,583,542" />
</map>
<img src="call_graph_for_process_line.gif" alt='' usemap="#call_graph_for_process_line" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="process_control_flow_line"></a><span class="summary-sig-name">process_control_flow_line</span>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_control_flow_line">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_control-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_control-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_control" name="call_graph_for_process_control">
<area shape="rect" href="epydoc.docparser-module.html#process_control_flow_line" title="process_control_flow_line()" alt="" coords="185,6,417,38" />
<area shape="rect" href="epydoc.docparser-module.html#script_guard" title="script_guard()" alt="" coords="468,6,593,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,6,135,38" />
</map>
<img src="call_graph_for_process_control.gif" alt='' usemap="#call_graph_for_process_control" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="process_import"></a><span class="summary-sig-name">process_import</span>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_import">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_import-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_import-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_import" name="call_graph_for_process_import">
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="_import_var()" alt="" coords="412,6,538,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="386,62,564,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="186,62,335,94" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="428,118,522,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,62,135,94" />
</map>
<img src="call_graph_for_process_import.gif" alt='' usemap="#call_graph_for_process_import" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="process_from_import"></a><span class="summary-sig-name">process_from_import</span>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_from_import">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_from_im-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_from_im-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_from_im" name="call_graph_for_process_from_im">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="429,6,680,38" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var_as" title="_import_var_as()" alt="" coords="479,62,631,94" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="439,118,671,150" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="465,174,644,206" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="493,230,616,262" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="185,146,380,178" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="508,286,601,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,146,135,178" />
</map>
<img src="call_graph_for_process_from_im.gif" alt='' usemap="#call_graph_for_process_from_im" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#_process_fromstar_import" class="summary-sig-name" onclick="show_private();">_process_fromstar_import</a>(<span class="summary-sig-arg">src</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
Handle a statement of the form:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_process_fromstar_import">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__process_fromst-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__process_fromst-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__process_fromst" name="call_graph_for__process_fromst">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="531,6,782,38" />
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="575,62,738,94" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="619,118,694,150" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="586,174,727,206" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="251,90,483,122" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,90,202,122" />
</map>
<img src="call_graph_for__process_fromst.gif" alt='' usemap="#call_graph_for__process_fromst" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#_import_var" class="summary-sig-name" onclick="show_private();">_import_var</a>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
Handle a statement of the form:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_import_var">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__import_var-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__import_var-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__import_var" name="call_graph_for__import_var">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="383,6,663,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__len__" title="apidoc.DottedName.__len__()" alt="" coords="399,62,647,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__radd__" title="apidoc.DottedName.__radd__()" alt="" coords="393,118,652,150" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="387,174,659,206" />
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="441,230,604,262" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="452,286,593,318" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="_import_var()" alt="" coords="207,146,332,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="7,146,156,178" />
</map>
<img src="call_graph_for__import_var.gif" alt='' usemap="#call_graph_for__import_var" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#_import_var_as" class="summary-sig-name" onclick="show_private();">_import_var_as</a>(<span class="summary-sig-arg">src</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
Handle a statement of the form:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_import_var_as">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__import_var_as-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__import_var_as-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__import_var_as" name="call_graph_for__import_var_as">
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="452,6,615,38" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="463,62,604,94" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var_as" title="_import_var_as()" alt="" coords="251,34,403,66" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,34,201,66" />
</map>
<img src="call_graph_for__import_var_as.gif" alt='' usemap="#call_graph_for__import_var_as" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_add_import_var"></a><span class="summary-sig-name">_add_import_var</span>(<span class="summary-sig-arg">src</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">container</span>)</span><br />
Add a new imported variable named <code>name</code> to
<code>container</code>, with <code>imported_from=src</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_add_import_var">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__add_import_var-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__add_import_var-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__add_import_var" name="call_graph_for__add_import_var">
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="499,34,750,66" />
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="287,62,450,94" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="563,90,686,122" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="_import_var()" alt="" coords="59,6,184,38" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var_as" title="_import_var_as()" alt="" coords="46,62,198,94" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="6,118,238,150" />
</map>
<img src="call_graph_for__add_import_var.gif" alt='' usemap="#call_graph_for__add_import_var" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_global_name"></a><span class="summary-sig-name">_global_name</span>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
If the given name is package-local (relative to the current context,
as determined by <code>parent_docs</code>), then convert it to a
global name.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_global_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__global_name-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__global_name-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__global_name" name="call_graph_for__global_name">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="504,6,728,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__add__" title="apidoc.DottedName.__add__()" alt="" coords="491,62,742,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="476,118,756,150" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="286,62,427,94" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="_import_var()" alt="" coords="59,6,184,38" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var_as" title="_import_var_as()" alt="" coords="46,62,198,94" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="6,118,238,150" />
</map>
<img src="call_graph_for__global_name.gif" alt='' usemap="#call_graph_for__global_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="process_assignment"></a><span class="summary-sig-name">process_assignment</span>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_assignment">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_assignm-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_assignm-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_assignm" name="call_graph_for_process_assignm">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="420,6,700,38" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="435,62,686,94" />
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="426,118,695,150" />
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="480,174,640,206" />
<area shape="rect" href="epydoc.docparser-module.html#get_lhs_parent" title="get_lhs_parent()" alt="" coords="488,230,632,262" />
<area shape="rect" href="epydoc.docparser-module.html#lhs_is_instvar" title="lhs_is_instvar()" alt="" coords="492,286,628,318" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="471,342,650,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="186,258,370,290" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="482,398,639,430" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="499,454,622,486" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="514,510,607,542" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,258,135,290" />
</map>
<img src="call_graph_for_process_assignm.gif" alt='' usemap="#call_graph_for_process_assignm" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="lhs_is_instvar"></a><span class="summary-sig-name">lhs_is_instvar</span>(<span class="summary-sig-arg">lhs_pieces</span>,
<span class="summary-sig-arg">parent_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#lhs_is_instvar">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_lhs_is_instvar-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_lhs_is_instvar-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_lhs_is_instvar" name="call_graph_for_lhs_is_instvar">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="427,6,651,38" />
<area shape="rect" href="epydoc.docparser-module.html#lhs_is_instvar" title="lhs_is_instvar()" alt="" coords="241,6,377,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,6,191,38" />
</map>
<img src="call_graph_for_lhs_is_instvar.gif" alt='' usemap="#call_graph_for_lhs_is_instvar" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="rhs_to_valuedoc"></a><span class="summary-sig-name">rhs_to_valuedoc</span>(<span class="summary-sig-arg">rhs</span>,
<span class="summary-sig-arg">parent_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#rhs_to_valuedoc">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_rhs_to_valuedoc-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_rhs_to_valuedoc-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_rhs_to_valuedoc" name="call_graph_for_rhs_to_valuedoc">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="465,6,681,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="448,62,699,94" />
<area shape="rect" href="epydoc.docparser-module.html#apply_decorator" title="apply_decorator()" alt="" coords="496,118,651,150" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="lookup_value()" alt="" coords="505,174,641,206" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="484,230,663,262" />
<area shape="rect" href="epydoc.docparser-module.html#pp_toktree" title="pp_toktree()" alt="" coords="516,286,631,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,146,191,178" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="241,146,399,178" />
</map>
<img src="call_graph_for_rhs_to_valuedoc.gif" alt='' usemap="#call_graph_for_rhs_to_valuedoc" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_lhs_parent"></a><span class="summary-sig-name">get_lhs_parent</span>(<span class="summary-sig-arg">lhs_name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#get_lhs_parent">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_lhs_parent-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_get_lhs_parent-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_get_lhs_parent" name="call_graph_for_get_lhs_parent">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#container" title="apidoc.DottedName.container()" alt="" coords="433,6,689,38" />
<area shape="rect" href="epydoc.docparser-module.html#get_lhs_parent" title="get_lhs_parent()" alt="" coords="240,34,384,66" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="lookup_value()" alt="" coords="493,62,629,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,34,191,66" />
</map>
<img src="call_graph_for_get_lhs_parent.gif" alt='' usemap="#call_graph_for_get_lhs_parent" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_one_line_block" class="summary-sig-name">process_one_line_block</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for single-line blocks, such as:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_one_line_block">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_one_lin-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_one_lin-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_one_lin" name="call_graph_for_process_one_lin">
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,6,135,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_one_line_block" title="process_one_line_block()" alt="" coords="184,6,400,38" />
</map>
<img src="call_graph_for_process_one_lin.gif" alt='' usemap="#call_graph_for_process_one_lin" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_multi_stmt" class="summary-sig-name">process_multi_stmt</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for semicolon-separated statements, such as:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_multi_stmt">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_multi_s-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_multi_s-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_multi_s" name="call_graph_for_process_multi_s">
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,6,135,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_multi_stmt" title="process_multi_stmt()" alt="" coords="184,6,366,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="415,6,508,38" />
</map>
<img src="call_graph_for_process_multi_s.gif" alt='' usemap="#call_graph_for_process_multi_s" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_del" class="summary-sig-name">process_del</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for delete statements, such as:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_del">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_del-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_del-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_del" name="call_graph_for_process_del">
<area shape="rect" href="epydoc.docparser-module.html#del_variable" title="del_variable()" alt="" coords="376,6,501,38" />
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="359,62,519,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="185,62,308,94" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="392,118,485,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,62,135,94" />
</map>
<img src="call_graph_for_process_del.gif" alt='' usemap="#call_graph_for_process_del" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_docstring" class="summary-sig-name">process_docstring</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for bare string literals.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_docstri-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_docstri-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_docstri" name="call_graph_for_process_docstri">
<area shape="rect" href="epydoc.docparser-module.html#parse_string" title="parse_string()" alt="" coords="404,6,529,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="184,34,355,66" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="405,62,528,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,34,135,66" />
</map>
<img src="call_graph_for_process_docstri.gif" alt='' usemap="#call_graph_for_process_docstri" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_funcdef" class="summary-sig-name">process_funcdef</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for function declaration lines, such as:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_funcdef">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_funcdef-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_funcdef-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_funcdef" name="call_graph_for_process_funcdef">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="418,6,634,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="400,62,651,94" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="400,118,651,150" />
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="391,174,660,206" />
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="468,230,583,262" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="464,286,587,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="184,174,342,206" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="464,342,587,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,174,135,206" />
</map>
<img src="call_graph_for_process_funcdef.gif" alt='' usemap="#call_graph_for_process_funcdef" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="apply_decorator"></a><span class="summary-sig-name">apply_decorator</span>(<span class="summary-sig-arg">decorator_name</span>,
<span class="summary-sig-arg">func_doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#apply_decorator">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_apply_decorator-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_apply_decorator-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_apply_decorator" name="call_graph_for_apply_decorator">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="437,6,653,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="417,62,673,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="420,118,671,150" />
<area shape="rect" href="epydoc.docparser-module.html#apply_decorator" title="apply_decorator()" alt="" coords="213,62,368,94" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="7,62,164,94" />
</map>
<img src="call_graph_for_apply_decorator.gif" alt='' usemap="#call_graph_for_apply_decorator" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="init_arglist"></a><span class="summary-sig-name">init_arglist</span>(<span class="summary-sig-arg">func_doc</span>,
<span class="summary-sig-arg">arglist</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#init_arglist">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_init_arglist-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_init_arglist-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_init_arglist" name="call_graph_for_init_arglist">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="376,6,592,38" />
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="212,90,327,122" />
<area shape="rect" href="epydoc.docparser-module.html#parse_funcdef_arg" title="parse_funcdef_arg()" alt="" coords="397,62,571,94" />
<area shape="rect" href="epydoc.docparser-module.html#pp_toktree" title="pp_toktree()" alt="" coords="427,118,541,150" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="437,174,531,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="5,90,163,122" />
</map>
<img src="call_graph_for_init_arglist.gif" alt='' usemap="#call_graph_for_init_arglist" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#process_classdef" class="summary-sig-name">process_classdef</a>(<span class="summary-sig-arg">line</span>,
<span class="summary-sig-arg">parent_docs</span>,
<span class="summary-sig-arg">prev_line_doc</span>,
<span class="summary-sig-arg">lineno</span>,
<span class="summary-sig-arg">comments</span>,
<span class="summary-sig-arg">decorators</span>,
<span class="summary-sig-arg">encoding</span>)</span><br />
The line handler for class declaration lines, such as:</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#process_classdef">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_classde-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_process_classde-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_classde" name="call_graph_for_process_classde">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="403,6,659,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="405,62,656,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="395,118,667,150" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="405,174,656,206" />
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="396,230,665,262" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="477,286,584,318" />
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="433,342,628,374" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="469,398,592,430" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="185,230,345,262" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="469,454,592,486" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,230,135,262" />
</map>
<img src="call_graph_for_process_classde.gif" alt='' usemap="#call_graph_for_process_classde" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_proxy_base"></a><span class="summary-sig-name">_proxy_base</span>(<span class="summary-sig-arg">**attribs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_proxy_base">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__proxy_base-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__proxy_base-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__proxy_base" name="call_graph_for__proxy_base">
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="339,6,611,38" />
<area shape="rect" href="epydoc.docparser-module.html#_proxy_base" title="_proxy_base()" alt="" coords="160,6,291,38" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="5,6,112,38" />
</map>
<img src="call_graph_for__proxy_base.gif" alt='' usemap="#call_graph_for__proxy_base" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="find_base"></a><span class="summary-sig-name">find_base</span>(<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#find_base">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_find_base-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_find_base-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_find_base" name="call_graph_for_find_base">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="384,6,640,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="372,62,652,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="387,118,638,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="391,174,634,206" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="387,230,638,262" />
<area shape="rect" href="epydoc.docparser-module.html#_proxy_base" title="_proxy_base()" alt="" coords="447,286,578,318" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="216,258,323,290" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_name" title="lookup_name()" alt="" coords="444,342,580,374" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_variable" title="lookup_variable()" alt="" coords="435,398,590,430" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="454,454,571,486" />
<area shape="rect" href="epydoc.log-module.html#info" title="log.info()" alt="" coords="467,510,558,542" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="7,258,167,290" />
</map>
<img src="call_graph_for_find_base.gif" alt='' usemap="#call_graph_for_find_base" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Parsing</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="dotted_names_in"></a><span class="summary-sig-name">dotted_names_in</span>(<span class="summary-sig-arg">elt_list</span>)</span><br />
Return a list of all simple dotted names in the given expression.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#dotted_names_in">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_dotted_names_in-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_dotted_names_in-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_dotted_names_in" name="call_graph_for_dotted_names_in">
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="241,34,401,66" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="452,34,631,66" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,6,191,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="37,62,160,94" />
</map>
<img src="call_graph_for_dotted_names_in.gif" alt='' usemap="#call_graph_for_dotted_names_in" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_name" class="summary-sig-name">parse_name</a>(<span class="summary-sig-arg">elt</span>,
<span class="summary-sig-arg">strip_parens</span>=<span class="summary-sig-default">False</span>)</span><br />
If the given token tree element is a name token, then return that
name as a string.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_name-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_name-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_name" name="call_graph_for_parse_name">
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="15,6,193,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="252,90,375,122" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="24,62,184,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,118,201,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="25,174,183,206" />
</map>
<img src="call_graph_for_parse_name.gif" alt='' usemap="#call_graph_for_parse_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_dotted_name" class="summary-sig-name">parse_dotted_name</a>(<span class="summary-sig-arg">elt_list</span>,
<span class="summary-sig-arg">strip_parens</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">parent_name</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_dotted_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_dotted_na-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_dotted_na-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_dotted_na" name="call_graph_for_parse_dotted_na">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="480,118,731,150" />
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="24,6,184,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="252,146,431,178" />
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="7,62,201,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="544,174,667,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="12,118,196,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,174,201,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="29,230,179,262" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="25,286,183,318" />
</map>
<img src="call_graph_for_parse_dotted_na.gif" alt='' usemap="#call_graph_for_parse_dotted_na" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="split_on"></a><span class="summary-sig-name">split_on</span>(<span class="summary-sig-arg">elt_list</span>,
<span class="summary-sig-arg">split_tok</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#split_on">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_split_on-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_split_on-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_split_on" name="call_graph_for_split_on">
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="47,6,161,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="252,202,345,234" />
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="7,62,201,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string_list" title="parse_string_list()" alt="" coords="25,118,183,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="12,174,196,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="43,230,165,262" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,286,201,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="29,342,179,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_multi_stmt" title="process_multi_stmt()" alt="" coords="13,398,195,430" />
</map>
<img src="call_graph_for_split_on.gif" alt='' usemap="#call_graph_for_split_on" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_funcdef_arg" class="summary-sig-name">parse_funcdef_arg</a>(<span class="summary-sig-arg">elt</span>)</span><br />
If the given tree token element contains a valid function definition
argument (i.e., an identifier token or nested list of identifiers),
then return a corresponding string identifier or nested list of
string identifiers.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_funcdef_arg">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_funcdef_a-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_funcdef_a-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_funcdef_a" name="call_graph_for_parse_funcdef_a">
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="7,30,121,62" />
<area shape="rect" href="epydoc.docparser-module.html#parse_funcdef_arg" title="parse_funcdef_arg()" alt="" coords="171,30,344,62" />
</map>
<img src="call_graph_for_parse_funcdef_a.gif" alt='' usemap="#call_graph_for_parse_funcdef_a" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_classdef_bases" class="summary-sig-name">parse_classdef_bases</a>(<span class="summary-sig-arg">elt</span>)</span><br />
If the given tree token element contains a valid base list (that
contains only dotted names), then return a corresponding list of <a
href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a>s.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_classdef_bases">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_classdef_-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_classdef_-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_classdef_" name="call_graph_for_parse_classdef_">
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="216,34,411,66" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="460,6,639,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="503,62,596,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="7,34,167,66" />
</map>
<img src="call_graph_for_parse_classdef_.gif" alt='' usemap="#call_graph_for_parse_classdef_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#parse_dotted_name_list" class="summary-sig-name">parse_dotted_name_list</a>(<span class="summary-sig-arg">elt_list</span>)</span><br />
If the given list of tree token elements contains a comma-separated
list of dotted names, then return a corresponding list of <a
href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a> objects.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_dotted_name_list">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="parse_string"></a><span class="summary-sig-name">parse_string</span>(<span class="summary-sig-arg">elt_list</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_string">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_string-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_string-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_string" name="call_graph_for_parse_string">
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="7,6,257,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string" title="parse_string()" alt="" coords="308,62,433,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string_list" title="parse_string_list()" alt="" coords="53,62,211,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="47,118,217,150" />
</map>
<img src="call_graph_for_parse_string.gif" alt='' usemap="#call_graph_for_parse_string" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="parse_string_list"></a><span class="summary-sig-name">parse_string_list</span>(<span class="summary-sig-arg">elt_list</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_string_list">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_string_li-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_parse_string_li-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_string_li" name="call_graph_for_parse_string_li">
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="7,34,257,66" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string_list" title="parse_string_list()" alt="" coords="308,34,465,66" />
<area shape="rect" href="epydoc.docparser-module.html#parse_string" title="parse_string()" alt="" coords="516,6,641,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="532,62,625,94" />
</map>
<img src="call_graph_for_parse_string_li.gif" alt='' usemap="#call_graph_for_parse_string_li" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Variable Manipulation</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#set_variable" class="summary-sig-name">set_variable</a>(<span class="summary-sig-arg">namespace</span>,
<span class="summary-sig-arg">var_doc</span>,
<span class="summary-sig-arg">preserve_docstring</span>=<span class="summary-sig-default">False</span>)</span><br />
Add var_doc to namespace.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#set_variable">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_set_variable-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_set_variable-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_set_variable" name="call_graph_for_set_variable">
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="18,6,180,38" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="242,118,364,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,62,191,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="19,118,179,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="14,174,184,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="20,230,178,262" />
</map>
<img src="call_graph_for_set_variable.gif" alt='' usemap="#call_graph_for_set_variable" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="del_variable"></a><span class="summary-sig-name">del_variable</span>(<span class="summary-sig-arg">namespace</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#del_variable">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_del_variable-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_del_variable-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_del_variable" name="call_graph_for_del_variable">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="356,6,636,38" />
<area shape="rect" href="epydoc.docparser-module.html#del_variable" title="del_variable()" alt="" coords="180,6,306,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="7,6,130,38" />
</map>
<img src="call_graph_for_del_variable.gif" alt='' usemap="#call_graph_for_del_variable" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Name Lookup</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><a href="epydoc.apidoc.VariableDoc-class.html"
class="link">VariableDoc</a> or <code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="lookup_name"></a><span class="summary-sig-name">lookup_name</span>(<span class="summary-sig-arg">identifier</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
Find and return the documentation for the variable named by the given
identifier.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#lookup_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_lookup_name-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_lookup_name-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_lookup_name" name="call_graph_for_lookup_name">
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_docs" title="docintrospecter.introspect_docs()" alt="" coords="393,62,663,94" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="29,6,136,38" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_name" title="lookup_name()" alt="" coords="208,62,344,94" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="lookup_value()" alt="" coords="15,62,151,94" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_variable" title="lookup_variable()" alt="" coords="5,118,160,150" />
</map>
<img src="call_graph_for_lookup_name.gif" alt='' usemap="#call_graph_for_lookup_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="lookup_variable"></a><span class="summary-sig-name">lookup_variable</span>(<span class="summary-sig-arg">dotted_name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#lookup_variable">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_lookup_variable-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_lookup_variable-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_lookup_variable" name="call_graph_for_lookup_variable">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="364,6,644,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__len__" title="apidoc.DottedName.__len__()" alt="" coords="380,62,628,94" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="6,90,112,122" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_variable" title="lookup_variable()" alt="" coords="160,90,315,122" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_name" title="lookup_name()" alt="" coords="436,118,572,150" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="lookup_value()" alt="" coords="436,174,572,206" />
</map>
<img src="call_graph_for_lookup_variable.gif" alt='' usemap="#call_graph_for_lookup_variable" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="lookup_value"></a><span class="summary-sig-name">lookup_value</span>(<span class="summary-sig-arg">dotted_name</span>,
<span class="summary-sig-arg">parent_docs</span>)</span><br />
Find and return the documentation for the value contained in the
variable with the given name in the current namespace.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#lookup_value">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_lookup_value-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_lookup_value-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_lookup_value" name="call_graph_for_lookup_value">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="431,6,647,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__add__" title="apidoc.DottedName.__add__()" alt="" coords="413,62,664,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="411,118,667,150" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="399,174,679,206" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__str__" title="apidoc.DottedName.__str__()" alt="" coords="417,230,660,262" />
<area shape="rect" href="epydoc.docparser-module.html#get_lhs_parent" title="get_lhs_parent()" alt="" coords="13,90,157,122" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="lookup_value()" alt="" coords="213,146,349,178" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_name" title="lookup_name()" alt="" coords="471,286,607,318" />
<area shape="rect" href="epydoc.docparser-module.html#lookup_variable" title="lookup_variable()" alt="" coords="8,146,163,178" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="7,202,164,234" />
</map>
<img src="call_graph_for_lookup_value.gif" alt='' usemap="#call_graph_for_lookup_value" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Docstring Comments</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="add_docstring_from_comments"></a><span class="summary-sig-name">add_docstring_from_comments</span>(<span class="summary-sig-arg">api_doc</span>,
<span class="summary-sig-arg">comments</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#add_docstring_from_comments">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_add_docstring_f-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_add_docstring_f-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_add_docstring_f" name="call_graph_for_add_docstring_f">
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="241,62,511,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,6,191,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="19,62,179,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="20,118,177,150" />
</map>
<img src="call_graph_for_add_docstring_f.gif" alt='' usemap="#call_graph_for_add_docstring_f" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Tree tokens</th></tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_join_toktree"></a><span class="summary-sig-name">_join_toktree</span>(<span class="summary-sig-arg">s1</span>,
<span class="summary-sig-arg">s2</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_join_toktree">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_toktree_add_piece"></a><span class="summary-sig-name">_pp_toktree_add_piece</span>(<span class="summary-sig-arg">spacing</span>,
<span class="summary-sig-arg">pieces</span>,
<span class="summary-sig-arg">piece</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_pp_toktree_add_piece">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__pp_toktree_add-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__pp_toktree_add-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__pp_toktree_add" name="call_graph_for__pp_toktree_add">
<area shape="rect" href="epydoc.docparser-module.html#_pp_toktree" title="_pp_toktree()" alt="" coords="7,6,130,38" />
<area shape="rect" href="epydoc.docparser-module.html#_pp_toktree_add_piece" title="_pp_toktree_add_piece()" alt="" coords="180,6,388,38" />
</map>
<img src="call_graph_for__pp_toktree_add.gif" alt='' usemap="#call_graph_for__pp_toktree_add" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="pp_toktree"></a><span class="summary-sig-name">pp_toktree</span>(<span class="summary-sig-arg">elts</span>,
<span class="summary-sig-arg">spacing</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">normal</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">indent</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#pp_toktree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_pp_toktree-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_pp_toktree-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_pp_toktree" name="call_graph_for_pp_toktree">
<area shape="rect" href="epydoc.docparser-module.html#_pp_toktree" title="_pp_toktree()" alt="" coords="378,34,500,66" />
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="28,6,143,38" />
<area shape="rect" href="epydoc.docparser-module.html#pp_toktree" title="pp_toktree()" alt="" coords="214,34,328,66" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="7,62,164,94" />
</map>
<img src="call_graph_for_pp_toktree.gif" alt='' usemap="#call_graph_for_pp_toktree" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_pp_toktree"></a><span class="summary-sig-name">_pp_toktree</span>(<span class="summary-sig-arg">elts</span>,
<span class="summary-sig-arg">spacing</span>,
<span class="summary-sig-arg">indent</span>,
<span class="summary-sig-arg">pieces</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_pp_toktree">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__pp_toktree-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__pp_toktree-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__pp_toktree" name="call_graph_for__pp_toktree">
<area shape="rect" href="epydoc.docparser-module.html#_pp_toktree" title="_pp_toktree()" alt="" coords="169,30,292,62" />
<area shape="rect" href="epydoc.docparser-module.html#_pp_toktree_add_piece" title="_pp_toktree_add_piece()" alt="" coords="343,30,551,62" />
<area shape="rect" href="epydoc.docparser-module.html#pp_toktree" title="pp_toktree()" alt="" coords="5,30,120,62" />
</map>
<img src="call_graph_for__pp_toktree.gif" alt='' usemap="#call_graph_for__pp_toktree" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Helper Functions</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#get_module_encoding" class="summary-sig-name">get_module_encoding</a>(<span class="summary-sig-arg">filename</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#get_module_encoding">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_module_enco-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for_get_module_enco-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_get_module_enco" name="call_graph_for_get_module_enco">
<area shape="rect" href="epydoc.docparser-module.html#get_module_encoding" title="get_module_encoding()" alt="" coords="179,6,379,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,6,131,38" />
</map>
<img src="call_graph_for_get_module_enco.gif" alt='' usemap="#call_graph_for_get_module_enco" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_get_module_name"></a><span class="summary-sig-name">_get_module_name</span>(<span class="summary-sig-arg">filename</span>,
<span class="summary-sig-arg">package_doc</span>)</span><br />
Return (dotted_name, is_package)</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#_get_module_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get_module_nam-summary-div');return false;">call graph</a></span>
</td>
</tr>
</table>
<div style="display:none" id="call_graph_for__get_module_nam-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__get_module_nam" name="call_graph_for__get_module_nam">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="405,6,656,38" />
<area shape="rect" href="epydoc.docparser-module.html#_get_module_name" title="_get_module_name()" alt="" coords="175,6,356,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="7,6,124,38" />
</map>
<img src="call_graph_for__get_module_nam.gif" alt='' usemap="#call_graph_for__get_module_nam" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.docparser-module.html#flatten" class="summary-sig-name">flatten</a>(<span class="summary-sig-arg">lst</span>,
<span class="summary-sig-arg">out</span>=<span class="summary-sig-default">None</span>)</span><br />
Returns:
a flat list containing the leaves of the given nested list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.docparser-pysrc.html#flatten">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>dict</code></span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#_moduledoc_cache" class="summary-name" onclick="show_private();">_moduledoc_cache</a> = <code title="{'/home/edloper/newdata/projects/docutils/docutils/__init__.py': <Modu\
leDoc docutils>,
'/home/edloper/newdata/projects/docutils/docutils/nodes.py': <ModuleD\
oc docutils.nodes>,
'/home/edloper/newdata/projects/docutils/docutils/utils.py': <ModuleD\
oc docutils.utils>,
'/home/edloper/newdata/projects/docutils/docutils/writers/__init__.py\
': <ModuleDoc docutils.writers>,
..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">/home/edloper/newdata/projects/docutils/d</code><code class="variable-ellipsis">...</code></code><br />
A cache of <code>ModuleDoc</code>s that we've already created.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Configuration Constants: Control Flow</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_TRY_BLOCKS"></a><span class="summary-name">PARSE_TRY_BLOCKS</span> = <code title="True">True</code><br />
Should the contents of <code>try</code> blocks be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_EXCEPT_BLOCKS"></a><span class="summary-name">PARSE_EXCEPT_BLOCKS</span> = <code title="True">True</code><br />
Should the contents of <code>except</code> blocks be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_FINALLY_BLOCKS"></a><span class="summary-name">PARSE_FINALLY_BLOCKS</span> = <code title="True">True</code><br />
Should the contents of <code>finally</code> blocks be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_IF_BLOCKS"></a><span class="summary-name">PARSE_IF_BLOCKS</span> = <code title="True">True</code><br />
Should the contents of <code>if</code> blocks be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_ELSE_BLOCKS"></a><span class="summary-name">PARSE_ELSE_BLOCKS</span> = <code title="True">True</code><br />
Should the contents of <code>else</code> and <code>elif</code> blocks
be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_WHILE_BLOCKS"></a><span class="summary-name">PARSE_WHILE_BLOCKS</span> = <code title="False">False</code><br />
Should the contents of <code>while</code> blocks be examined?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PARSE_FOR_BLOCKS"></a><span class="summary-name">PARSE_FOR_BLOCKS</span> = <code title="False">False</code><br />
Should the contents of <code>for</code> blocks be examined?
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Configuration Constants: Imports</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#IMPORT_HANDLING" class="summary-name">IMPORT_HANDLING</a> = <code title="'link'"><code class="variable-quote">'</code><code class="variable-string">link</code><code class="variable-quote">'</code></code><br />
What should <code>docparser</code> do when it encounters an import
statement?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#IMPORT_STAR_HANDLING" class="summary-name">IMPORT_STAR_HANDLING</a> = <code title="'parse'"><code class="variable-quote">'</code><code class="variable-string">parse</code><code class="variable-quote">'</code></code><br />
When <code>docparser</code> encounters a <code>'from <i
class="math">m</i> import *'</code> statement, and is unable to parse
<code><i class="math">m</i></code> (either because <a
href="epydoc.docparser-module.html#IMPORT_HANDLING"
class="link">IMPORT_HANDLING</a>=<code>'link'</code>, or because
parsing failed), how should it determine the list of identifiers
expored by <code><i class="math">m</i></code>?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#DEFAULT_DECORATOR_BEHAVIOR" class="summary-name">DEFAULT_DECORATOR_BEHAVIOR</a> = <code title="'transparent'"><code class="variable-quote">'</code><code class="variable-string">transparent</code><code class="variable-quote">'</code></code><br />
When <code>DocParse</code> encounters an unknown decorator, what
should it do to the documentation of the decorated function?
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#BASE_HANDLING" class="summary-name">BASE_HANDLING</a> = <code title="'parse'"><code class="variable-quote">'</code><code class="variable-string">parse</code><code class="variable-quote">'</code></code><br />
What should <code>docparser</code> do when it encounters a base class
that was imported from another module?
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Configuration Constants: Comment docstrings</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="COMMENT_DOCSTRING_MARKER"></a><span class="summary-name">COMMENT_DOCSTRING_MARKER</span> = <code title="'#:'"><code class="variable-quote">'</code><code class="variable-string">#:</code><code class="variable-quote">'</code></code><br />
The prefix used to mark comments that contain attribute docstrings
for variables.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Configuration Constants: Grouping</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#START_GROUP_MARKER" class="summary-name">START_GROUP_MARKER</a> = <code title="'#{'"><code class="variable-quote">'</code><code class="variable-string">#{</code><code class="variable-quote">'</code></code><br />
The prefix used to mark a comment that starts a group.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#END_GROUP_MARKER" class="summary-name">END_GROUP_MARKER</a> = <code title="'#}'"><code class="variable-quote">'</code><code class="variable-string">#}</code><code class="variable-quote">'</code></code><br />
The prefix used to mark a comment that ends a group.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Line processing</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="epydoc.docparser-module.html#CONTROL_FLOW_KEYWORDS" class="summary-name">CONTROL_FLOW_KEYWORDS</a> = <code title="['if', 'elif', 'else', 'while', 'for', 'try', 'except', 'finally']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">if</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">else</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">while</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">for</code><code class="variable-quote">'</code><code class="variable-op">,</code><code class="variable-ellipsis">...</code></code><br />
A list of the control flow keywords.
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="parse_docs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_docs</span>(<span class="sig-arg">filename</span>=<span class="sig-default">None</span>,
<span class="sig-arg">name</span>=<span class="sig-default">None</span>,
<span class="sig-arg">context</span>=<span class="sig-default">None</span>,
<span class="sig-arg">is_script</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_docs">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_docs-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_docs-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_docs" name="call_graph_for_parse_docs">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="571,62,821,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="560,118,832,150" />
<area shape="rect" href="epydoc.docbuilder-module.html#_get_docs_from_module_file" title="docbuilder._get_docs_from_module_file()" alt="" coords="5,202,344,234" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="393,230,511,262" />
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_docs" title="docintrospecter.introspect_docs()" alt="" coords="561,174,831,206" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="659,6,733,38" />
<area shape="rect" href="epydoc.docparser-module.html#_get_module_name" title="_get_module_name()" alt="" coords="605,230,787,262" />
<area shape="rect" href="epydoc.docparser-module.html#_parse_package" title="_parse_package()" alt="" coords="619,286,773,318" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="121,258,228,290" />
<area shape="rect" href="epydoc.docparser-module.html#handle_special_module_vars" title="handle_special_module_vars()" alt="" coords="571,342,821,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="633,398,759,430" />
<area shape="rect" href="epydoc.log-module.html#info" title="log.info()" alt="" coords="651,454,741,486" />
<area shape="rect" href="epydoc.util-module.html#py_src_filename" title="util.py_src_filename()" alt="" coords="601,510,791,542" />
</map>
<img src="call_graph_for_parse_docs.gif" alt='' usemap="#call_graph_for_parse_docs" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Generate the API documentation for a specified object by parsing
Python source files, and return it as a <a
href="epydoc.apidoc.ValueDoc-class.html" class="link">ValueDoc</a>. The
object to generate documentation for may be specified using the
<code>filename</code> parameter <i>or</i> the <code>name</code>
parameter. (It is an error to specify both a filename and a name; or to
specify neither a filename nor a name).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>filename</code></strong> - The name of the file that contains the python source code for a
package, module, or script. If <code>filename</code> is
specified, then <code>parse</code> will return a
<code>ModuleDoc</code> describing its contents.</li>
<li><strong class="pname"><code>name</code></strong> - The fully-qualified python dotted name of any value (including
packages, modules, classes, and functions).
<code>parse_docs()</code> will automatically figure out which
module(s) it needs to parse in order to find the documentation
for the specified object.</li>
<li><strong class="pname"><code>context</code></strong> - The API documentation for the package that contains
<code>filename</code>. If no context is given, then
<code>filename</code> is assumed to contain a top-level module or
package. It is an error to specify a <code>context</code> if the
<code>name</code> argument is used.</li>
</ul></dd>
<dt>Returns: <a href="epydoc.apidoc.ValueDoc-class.html" class="link">ValueDoc</a></dt>
</dl>
</td></tr></table>
</div>
<a name="_find"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_find</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">package_doc</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#_find">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__find-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__find-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__find" name="call_graph_for__find">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="409,6,689,38" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="285,146,360,178" />
<area shape="rect" href="epydoc.docparser-module.html#_find_in_namespace" title="_find_in_namespace()" alt="" coords="455,62,644,94" />
<area shape="rect" href="epydoc.docparser-module.html#_get_filename" title="_get_filename()" alt="" coords="479,118,620,150" />
<area shape="rect" href="epydoc.docparser-module.html#_is_submodule_import_var" title="_is_submodule_import_var()" alt="" coords="429,174,669,206" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="491,230,608,262" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="5,146,237,178" />
</map>
<img src="call_graph_for__find.gif" alt='' usemap="#call_graph_for__find" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return the API documentaiton for the object whose name is
<code>name</code>. <code>package_doc</code>, if specified, is the API
documentation for the package containing the named object.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_is_submodule_import_var"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_is_submodule_import_var</span>(<span class="sig-arg">module_doc</span>,
<span class="sig-arg">var_name</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#_is_submodule_import_var">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__is_submodule_i-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__is_submodule_i-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__is_submodule_i" name="call_graph_for__is_submodule_i">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="417,6,673,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="420,62,671,94" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="5,34,80,66" />
<area shape="rect" href="epydoc.docparser-module.html#_is_submodule_import_var" title="_is_submodule_import_var()" alt="" coords="128,34,368,66" />
</map>
<img src="call_graph_for__is_submodule_i.gif" alt='' usemap="#call_graph_for__is_submodule_i" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Return true if <code>var_name</code> is the name of a variable in
<code>module_doc</code> that just contains an <code>imported_from</code>
link to a submodule of the same name. (I.e., is a variable created when
a package imports one of its own submodules.)</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_file"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_file</span>(<span class="sig-arg">module_doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_file">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_file-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_file-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_file" name="call_graph_for_process_file">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="apidoc.APIDoc.__cmp__()" alt="" coords="383,6,607,38" />
<area shape="rect" href="epydoc.docparser-module.html#add_to_group" title="add_to_group()" alt="" coords="427,62,563,94" />
<area shape="rect" href="epydoc.docparser-module.html#get_module_encoding" title="get_module_encoding()" alt="" coords="395,118,595,150" />
<area shape="rect" href="epydoc.docparser-module.html#parse_docs" title="parse_docs()" alt="" coords="7,146,124,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="173,146,299,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="431,174,559,206" />
<area shape="rect" href="epydoc.docparser-module.html#shallow_parse" title="shallow_parse()" alt="" coords="424,230,565,262" />
<area shape="rect" href="epydoc.util-module.html#decode_with_backslashreplace" title="util.decode_with_backslashreplace()" alt="" coords="347,286,643,318" />
</map>
<img src="call_graph_for_process_file.gif" alt='' usemap="#call_graph_for_process_file" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Read the given <code>ModuleDoc</code>'s file, and add variables
corresponding to any objects defined in that file. In particular, read
and tokenize <code>module_doc.filename</code>, and process each logical
line using <a href="epydoc.docparser-module.html#process_line"
class="link">process_line()</a>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="shallow_parse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">shallow_parse</span>(<span class="sig-arg">line_toks</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#shallow_parse">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_shallow_parse-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_shallow_parse-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_shallow_parse" name="call_graph_for_shallow_parse">
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,6,131,38" />
<area shape="rect" href="epydoc.docparser-module.html#shallow_parse" title="shallow_parse()" alt="" coords="179,6,320,38" />
</map>
<img src="call_graph_for_shallow_parse.gif" alt='' usemap="#call_graph_for_shallow_parse" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Given a flat list of tokens, return a nested tree structure (called a
<a name="index-token_tree"></a><i class="indexterm">token tree</i>),
whose leaves are identical to the original list, but whose structure
reflects the structure implied by the grouping tokens (i.e., parenthases,
braces, and brackets). If the parenthases, braces, and brackets do not
match, or are not balanced, then raise a ParseError.</p>
<p>Assign some structure to a sequence of structure (group parens).</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_line"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_line</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_line">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_line-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_line-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_line" name="call_graph_for_process_line">
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="383,6,567,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="395,62,555,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_control_flow_line" title="process_control_flow_line()" alt="" coords="359,118,591,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="413,174,536,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="389,230,560,262" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,314,131,346" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="180,314,308,346" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="377,286,572,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="396,342,553,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="400,398,549,430" />
<area shape="rect" href="epydoc.docparser-module.html#process_multi_stmt" title="process_multi_stmt()" alt="" coords="384,454,565,486" />
<area shape="rect" href="epydoc.docparser-module.html#process_one_line_block" title="process_one_line_block()" alt="" coords="367,510,583,542" />
</map>
<img src="call_graph_for_process_line.gif" alt='' usemap="#call_graph_for_process_line" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
<dt>Returns:</dt>
<dd><code>new-doc</code>, <code>decorator</code>..?</dd>
</dl>
</td></tr></table>
</div>
<a name="_process_fromstar_import"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_process_fromstar_import</span>(<span class="sig-arg">src</span>,
<span class="sig-arg">parent_docs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#_process_fromstar_import">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__process_fromst-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__process_fromst-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__process_fromst" name="call_graph_for__process_fromst">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="531,6,782,38" />
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="575,62,738,94" />
<area shape="rect" href="epydoc.docparser-module.html#_find" title="_find()" alt="" coords="619,118,694,150" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="586,174,727,206" />
<area shape="rect" href="epydoc.docparser-module.html#_process_fromstar_import" title="_process_fromstar_import()" alt="" coords="251,90,483,122" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,90,202,122" />
</map>
<img src="call_graph_for__process_fromst.gif" alt='' usemap="#call_graph_for__process_fromst" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Handle a statement of the form:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">from</span> <src> <span class="py-keyword">import</span> *</pre>
<p>If <a href="epydoc.docparser-module.html#IMPORT_HANDLING"
class="link">IMPORT_HANDLING</a> is <code>'parse'</code>, then first try
to parse the module <code><i class="math"><src></i></code>, and
copy all of its exported variables to <code>parent_docs[-1]</code>.</p>
<p>Otherwise, try to determine the names of the variables exported by
<code><i class="math"><src></i></code>, and create a new variable
for each export. If <a
href="epydoc.docparser-module.html#IMPORT_STAR_HANDLING"
class="link">IMPORT_STAR_HANDLING</a> is <code>'parse'</code>, then the
list of exports if found by parsing <code><i
class="math"><src></i></code>; if it is <code>'introspect'</code>,
then the list of exports is found by importing and introspecting <code><i
class="math"><src></i></code>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_import_var"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_import_var</span>(<span class="sig-arg">name</span>,
<span class="sig-arg">parent_docs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#_import_var">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__import_var-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__import_var-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__import_var" name="call_graph_for__import_var">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="apidoc.DottedName.__getitem__()" alt="" coords="383,6,663,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__len__" title="apidoc.DottedName.__len__()" alt="" coords="399,62,647,94" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__radd__" title="apidoc.DottedName.__radd__()" alt="" coords="393,118,652,150" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="387,174,659,206" />
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="441,230,604,262" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="452,286,593,318" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var" title="_import_var()" alt="" coords="207,146,332,178" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="7,146,156,178" />
</map>
<img src="call_graph_for__import_var.gif" alt='' usemap="#call_graph_for__import_var" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Handle a statement of the form:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">import</span> <name></pre>
<p>If <a href="epydoc.docparser-module.html#IMPORT_HANDLING"
class="link">IMPORT_HANDLING</a> is <code>'parse'</code>, then first try
to find the value by parsing; and create an appropriate variable in
parentdoc.</p>
<p>Otherwise, add a variable for the imported variable. (More than one
variable may be created for cases like <code>'import a.b'</code>, where
we need to create a variable <code>'a'</code> in parentdoc containing a
proxy module; and a variable <code>'b'</code> in the proxy module.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_import_var_as"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_import_var_as</span>(<span class="sig-arg">src</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">parent_docs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#_import_var_as">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__import_var_as-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for__import_var_as-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for__import_var_as" name="call_graph_for__import_var_as">
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="452,6,615,38" />
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="_global_name()" alt="" coords="463,62,604,94" />
<area shape="rect" href="epydoc.docparser-module.html#_import_var_as" title="_import_var_as()" alt="" coords="251,34,403,66" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,34,201,66" />
</map>
<img src="call_graph_for__import_var_as.gif" alt='' usemap="#call_graph_for__import_var_as" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Handle a statement of the form:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">import</span> src <span class="py-keyword">as</span> name</pre>
<p>If <a href="epydoc.docparser-module.html#IMPORT_HANDLING"
class="link">IMPORT_HANDLING</a> is <code>'parse'</code>, then first try
to find the value by parsing; and create an appropriate variable in
parentdoc.</p>
<p>Otherwise, create a variables with its <code>imported_from</code>
attribute pointing to the imported object.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_one_line_block"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_one_line_block</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_one_line_block">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_one_lin-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_one_lin-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_one_lin" name="call_graph_for_process_one_lin">
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,6,135,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_one_line_block" title="process_one_line_block()" alt="" coords="184,6,400,38" />
</map>
<img src="call_graph_for_process_one_lin.gif" alt='' usemap="#call_graph_for_process_one_lin" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for single-line blocks, such as:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">f</span>(x): return x*2</pre>
<p>This handler calls <a href="epydoc.docparser-module.html#process_line"
class="link">process_line</a> twice: once for the tokens up to and
including the colon, and once for the remaining tokens. The comment
docstring is applied to the first line only.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd><code>None</code></dd>
</dl>
</td></tr></table>
</div>
<a name="process_multi_stmt"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_multi_stmt</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_multi_stmt">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_multi_s-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_multi_s-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_multi_s" name="call_graph_for_process_multi_s">
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,6,135,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_multi_stmt" title="process_multi_stmt()" alt="" coords="184,6,366,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="415,6,508,38" />
</map>
<img src="call_graph_for_process_multi_s.gif" alt='' usemap="#call_graph_for_process_multi_s" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for semicolon-separated statements, such as:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>x=1; y=2; z=3</pre>
<p>This handler calls <a href="epydoc.docparser-module.html#process_line"
class="link">process_line</a> once for each statement. The comment
docstring is not passed on to any of the sub-statements.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd><code>None</code></dd>
</dl>
</td></tr></table>
</div>
<a name="process_del"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_del</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_del">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_del-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_del-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_del" name="call_graph_for_process_del">
<area shape="rect" href="epydoc.docparser-module.html#del_variable" title="del_variable()" alt="" coords="376,6,501,38" />
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="359,62,519,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_del" title="process_del()" alt="" coords="185,62,308,94" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="392,118,485,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,62,135,94" />
</map>
<img src="call_graph_for_process_del.gif" alt='' usemap="#call_graph_for_process_del" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for delete statements, such as:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">del</span> x, y.z</pre>
<p>This handler calls <a href="epydoc.docparser-module.html#del_variable"
class="link">del_variable</a> for each dotted variable in the variable
list. The variable list may be nested. Complex expressions in the
variable list (such as <code>x[3]</code>) are ignored.</p>
<dl class="fields">
<dt>Returns:</dt>
<dd><code>None</code></dd>
</dl>
</td></tr></table>
</div>
<a name="process_docstring"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_docstring</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_docstring">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_docstri-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_docstri-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_docstri" name="call_graph_for_process_docstri">
<area shape="rect" href="epydoc.docparser-module.html#parse_string" title="parse_string()" alt="" coords="404,6,529,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="184,34,355,66" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="405,62,528,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,34,135,66" />
</map>
<img src="call_graph_for_process_docstri.gif" alt='' usemap="#call_graph_for_process_docstri" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for bare string literals. If
<code>prev_line_doc</code> is not <code>None</code>, then the string
literal is added to that <code>APIDoc</code> as a docstring. If it
already has a docstring (from comment docstrings), then the new docstring
will be appended to the old one.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_funcdef"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_funcdef</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_funcdef">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_funcdef-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_funcdef-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_funcdef" name="call_graph_for_process_funcdef">
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="apidoc.APIDoc.__init__()" alt="" coords="418,6,634,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="400,62,651,94" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="400,118,651,150" />
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="391,174,660,206" />
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="468,230,583,262" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="464,286,587,318" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="184,174,342,206" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="464,342,587,374" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,174,135,206" />
</map>
<img src="call_graph_for_process_funcdef.gif" alt='' usemap="#call_graph_for_process_funcdef" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for function declaration lines, such as:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">def</span> <span class="py-defname">f</span>(a, b=22, (c,d)):</pre>
<p>This handler creates and initializes a new <code>VariableDoc</code>
containing a <code>RoutineDoc</code>, adds the <code>VariableDoc</code>
to the containing namespace, and returns the <code>RoutineDoc</code>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="process_classdef"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">process_classdef</span>(<span class="sig-arg">line</span>,
<span class="sig-arg">parent_docs</span>,
<span class="sig-arg">prev_line_doc</span>,
<span class="sig-arg">lineno</span>,
<span class="sig-arg">comments</span>,
<span class="sig-arg">decorators</span>,
<span class="sig-arg">encoding</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#process_classdef">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_process_classde-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_process_classde-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_process_classde" name="call_graph_for_process_classde">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="apidoc.DottedName.__cmp__()" alt="" coords="403,6,659,38" />
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="405,62,656,94" />
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="apidoc.NamespaceDoc.__init__()" alt="" coords="395,118,667,150" />
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="apidoc.VariableDoc.__init__()" alt="" coords="405,174,656,206" />
<area shape="rect" href="epydoc.docparser-module.html#add_docstring_from_comments" title="add_docstring_from_comments()" alt="" coords="396,230,665,262" />
<area shape="rect" href="epydoc.docparser-module.html#find_base" title="find_base()" alt="" coords="477,286,584,318" />
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="433,342,628,374" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="469,398,592,430" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="185,230,345,262" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="469,454,592,486" />
<area shape="rect" href="epydoc.docparser-module.html#process_line" title="process_line()" alt="" coords="7,230,135,262" />
</map>
<img src="call_graph_for_process_classde.gif" alt='' usemap="#call_graph_for_process_classde" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>The line handler for class declaration lines, such as:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span><span class="py-keyword">class</span> <span class="py-defname">Foo</span>(Bar, Baz):</pre>
<p>This handler creates and initializes a new <code>VariableDoc</code>
containing a <code>ClassDoc</code>, adds the <code>VariableDoc</code> to
the containing namespace, and returns the <code>ClassDoc</code>.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parse_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_name</span>(<span class="sig-arg">elt</span>,
<span class="sig-arg">strip_parens</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_name-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_name-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_name" name="call_graph_for_parse_name">
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="15,6,193,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="252,90,375,122" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="24,62,184,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,118,201,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="25,174,183,206" />
</map>
<img src="call_graph_for_parse_name.gif" alt='' usemap="#call_graph_for_parse_name" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>If the given token tree element is a name token, then return that name
as a string. Otherwise, raise ParseError.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>strip_parens</code></strong> - If true, then if elt is a single name enclosed in parenthases,
then return that name.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="parse_dotted_name"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_dotted_name</span>(<span class="sig-arg">elt_list</span>,
<span class="sig-arg">strip_parens</span>=<span class="sig-default">True</span>,
<span class="sig-arg">parent_name</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_dotted_name">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_dotted_na-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_dotted_na-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_dotted_na" name="call_graph_for_parse_dotted_na">
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="apidoc.DottedName.__init__()" alt="" coords="480,118,731,150" />
<area shape="rect" href="epydoc.docparser-module.html#dotted_names_in" title="dotted_names_in()" alt="" coords="24,6,184,38" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="252,146,431,178" />
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="7,62,201,94" />
<area shape="rect" href="epydoc.docparser-module.html#parse_name" title="parse_name()" alt="" coords="544,174,667,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="12,118,196,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_from_import" title="process_from_import()" alt="" coords="7,174,201,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_import" title="process_import()" alt="" coords="29,230,179,262" />
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="rhs_to_valuedoc()" alt="" coords="25,286,183,318" />
</map>
<img src="call_graph_for_parse_dotted_na.gif" alt='' usemap="#call_graph_for_parse_dotted_na" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent_name</code></strong> (<a href="epydoc.apidoc.DottedName-class.html"
class="link">DottedName</a>) - canonical name of referring module, to resolve relative imports.</li>
</ul></dd>
</dl>
<div class="fields"> <p><strong>Bug:</strong>
does not handle 'x.(y).z'
</p>
</div></td></tr></table>
</div>
<a name="parse_funcdef_arg"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_funcdef_arg</span>(<span class="sig-arg">elt</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_funcdef_arg">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_funcdef_a-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_funcdef_a-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_funcdef_a" name="call_graph_for_parse_funcdef_a">
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="init_arglist()" alt="" coords="7,30,121,62" />
<area shape="rect" href="epydoc.docparser-module.html#parse_funcdef_arg" title="parse_funcdef_arg()" alt="" coords="171,30,344,62" />
</map>
<img src="call_graph_for_parse_funcdef_a.gif" alt='' usemap="#call_graph_for_parse_funcdef_a" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>If the given tree token element contains a valid function definition
argument (i.e., an identifier token or nested list of identifiers), then
return a corresponding string identifier or nested list of string
identifiers. Otherwise, raise a ParseError.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="parse_classdef_bases"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_classdef_bases</span>(<span class="sig-arg">elt</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_classdef_bases">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_parse_classdef_-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_parse_classdef_-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_parse_classdef_" name="call_graph_for_parse_classdef_">
<area shape="rect" href="epydoc.docparser-module.html#parse_classdef_bases" title="parse_classdef_bases()" alt="" coords="216,34,411,66" />
<area shape="rect" href="epydoc.docparser-module.html#parse_dotted_name" title="parse_dotted_name()" alt="" coords="460,6,639,38" />
<area shape="rect" href="epydoc.docparser-module.html#split_on" title="split_on()" alt="" coords="503,62,596,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="7,34,167,66" />
</map>
<img src="call_graph_for_parse_classdef_.gif" alt='' usemap="#call_graph_for_parse_classdef_" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>If the given tree token element contains a valid base list (that
contains only dotted names), then return a corresponding list of <a
href="epydoc.apidoc.DottedName-class.html" class="link">DottedName</a>s.
Otherwise, raise a ParseError.</p>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>Bug:</strong>
Does not handle either of:
<pre class="literalblock">
- class A( (base.in.parens) ): pass
- class B( (lambda:calculated.base)() ): pass
</pre>
</p>
</div></td></tr></table>
</div>
<a name="parse_dotted_name_list"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse_dotted_name_list</span>(<span class="sig-arg">elt_list</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#parse_dotted_name_list">source code</a></span>
</td>
</tr></table>
<p>If the given list of tree token elements contains a comma-separated
list of dotted names, then return a corresponding list of <a
href="epydoc.apidoc.DottedName-class.html" class="link">DottedName</a>
objects. Otherwise, raise ParseError.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="set_variable"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">set_variable</span>(<span class="sig-arg">namespace</span>,
<span class="sig-arg">var_doc</span>,
<span class="sig-arg">preserve_docstring</span>=<span class="sig-default">False</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#set_variable">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_set_variable-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_set_variable-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_set_variable" name="call_graph_for_set_variable">
<area shape="rect" href="epydoc.docparser-module.html#_add_import_var" title="_add_import_var()" alt="" coords="18,6,180,38" />
<area shape="rect" href="epydoc.docparser-module.html#set_variable" title="set_variable()" alt="" coords="242,118,364,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_assignment" title="process_assignment()" alt="" coords="7,62,191,94" />
<area shape="rect" href="epydoc.docparser-module.html#process_classdef" title="process_classdef()" alt="" coords="19,118,179,150" />
<area shape="rect" href="epydoc.docparser-module.html#process_docstring" title="process_docstring()" alt="" coords="14,174,184,206" />
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="process_funcdef()" alt="" coords="20,230,178,262" />
</map>
<img src="call_graph_for_set_variable.gif" alt='' usemap="#call_graph_for_set_variable" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<p>Add var_doc to namespace. If namespace already contains a variable
with the same name, then discard the old variable. If
<code>preserve_docstring</code> is true, then keep the old variable's
docstring when overwriting a variable.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="get_module_encoding"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">get_module_encoding</span>(<span class="sig-arg">filename</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#get_module_encoding">source code</a></span>
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_module_enco-div');return false;">call graph</a></span> </td>
</tr></table>
<div style="display:none" id="call_graph_for_get_module_enco-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td><center> <map id="call_graph_for_get_module_enco" name="call_graph_for_get_module_enco">
<area shape="rect" href="epydoc.docparser-module.html#get_module_encoding" title="get_module_encoding()" alt="" coords="179,6,379,38" />
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="process_file()" alt="" coords="5,6,131,38" />
</map>
<img src="call_graph_for_get_module_enco.gif" alt='' usemap="#call_graph_for_get_module_enco" ismap="ismap" class="graph-without-title" />
</center></td></tr>
<tr><th>Call Graph</th></tr>
</table><br />
</center></div>
<dl class="fields">
</dl>
<div class="fields"> <p><strong>See Also:</strong>
<a href="http://www.python.org/peps/pep-0263.html"
target="_top">PEP 263</a>
</p>
</div></td></tr></table>
</div>
<a name="flatten"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">flatten</span>(<span class="sig-arg">lst</span>,
<span class="sig-arg">out</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.docparser-pysrc.html#flatten">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>lst</code></strong> - The nested list that should be flattened.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a flat list containing the leaves of the given nested list.</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Variables Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-VariablesDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_moduledoc_cache"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">_moduledoc_cache</h3>
<p>A cache of <code>ModuleDoc</code>s that we've already created.
<code>_moduledoc_cache</code> is a dictionary mapping from filenames to
<code>ValueDoc</code> objects.</p>
<dl class="fields">
<dt>Type:</dt>
<dd><code>dict</code></dd>
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">/home/edloper/newdata/projects/docutils/docutils/__init__.py</code><code class="variable-quote">'</code><code class="variable-op">: </code><Modu<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
leDoc docutils><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">/home/edloper/newdata/projects/docutils/docutils/nodes.py</code><code class="variable-quote">'</code><code class="variable-op">: </code><ModuleD<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
oc docutils.nodes><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">/home/edloper/newdata/projects/docutils/docutils/utils.py</code><code class="variable-quote">'</code><code class="variable-op">: </code><ModuleD<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
oc docutils.utils><code class="variable-op">,</code>
<code class="variable-quote">'</code><code class="variable-string">/home/edloper/newdata/projects/docutils/docutils/writers/__init__.py</code><code class="variable-quote"></code><span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-quote">'</code><code class="variable-op">: </code><ModuleDoc docutils.writers><code class="variable-op">,</code>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="IMPORT_HANDLING"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">IMPORT_HANDLING</h3>
<p>What should <code>docparser</code> do when it encounters an import
statement?</p>
<ul>
<li>
<code>'link'</code>: Create variabledoc objects with imported_from
pointers to the source object.
</li>
<li>
<code>'parse'</code>: Parse the imported file, to find the actual
documentation for the imported object. (This will fall back to the
'link' behavior if the imported file can't be parsed, e.g., if it's a
builtin.)
</li>
</ul>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">link</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="IMPORT_STAR_HANDLING"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">IMPORT_STAR_HANDLING</h3>
<p>When <code>docparser</code> encounters a <code>'from <i
class="math">m</i> import *'</code> statement, and is unable to parse
<code><i class="math">m</i></code> (either because <a
href="epydoc.docparser-module.html#IMPORT_HANDLING"
class="link">IMPORT_HANDLING</a>=<code>'link'</code>, or because parsing
failed), how should it determine the list of identifiers expored by
<code><i class="math">m</i></code>?</p>
<ul>
<li>
<code>'ignore'</code>: ignore the import statement, and don't create
any new variables.
</li>
<li>
<code>'parse'</code>: parse it to find a list of the identifiers that
it exports. (This will fall back to the 'ignore' behavior if the
imported file can't be parsed, e.g., if it's a builtin.)
</li>
<li>
<code>'introspect'</code>: import the module and introspect it (using
<code>dir</code>) to find a list of the identifiers that it exports.
(This will fall back to the 'ignore' behavior if the imported file
can't be parsed, e.g., if it's a builtin.)
</li>
</ul>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">parse</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="DEFAULT_DECORATOR_BEHAVIOR"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">DEFAULT_DECORATOR_BEHAVIOR</h3>
<p>When <code>DocParse</code> encounters an unknown decorator, what
should it do to the documentation of the decorated function?</p>
<ul>
<li>
<code>'transparent'</code>: leave the function's documentation as-is.
</li>
<li>
<code>'opaque'</code>: replace the function's documentation with an
empty <code>ValueDoc</code> object, reflecting the fact that we have
no knowledge about what value the decorator returns.
</li>
</ul>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">transparent</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="BASE_HANDLING"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">BASE_HANDLING</h3>
<p>What should <code>docparser</code> do when it encounters a base class
that was imported from another module?</p>
<ul>
<li>
<code>'link'</code>: Create a valuedoc with a <code>proxy_for</code>
pointer to the base class.
</li>
<li>
<code>'parse'</code>: Parse the file containing the base class, to
find the actual documentation for it. (This will fall back to the
'link' behavior if the imported file can't be parsed, e.g., if it's a
builtin.)
</li>
</ul>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">parse</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="START_GROUP_MARKER"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">START_GROUP_MARKER</h3>
<p>The prefix used to mark a comment that starts a group. This marker
should be followed (on the same line) by the name of the group. Following
a start-group comment, all variables defined at the same indentation
level will be assigned to this group name, until the parser reaches the
end of the file, a matching end-group comment, or another start-group
comment at the same indentation level.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">#{</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="END_GROUP_MARKER"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">END_GROUP_MARKER</h3>
<p>The prefix used to mark a comment that ends a group. See <a
href="epydoc.docparser-module.html#START_GROUP_MARKER"
class="link">START_GROUP_MARKER</a>.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-quote">'</code><code class="variable-string">#}</code><code class="variable-quote">'</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<a name="CONTROL_FLOW_KEYWORDS"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">CONTROL_FLOW_KEYWORDS</h3>
<p>A list of the control flow keywords. If a line begins with one of
these keywords, then it should be handled by
<code>process_control_flow_line</code>.</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">if</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">elif</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">else</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">while</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">for</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">try</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">except</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">finally</code><code class="variable-quote">'</code><code class="variable-group">]</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:06:21 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
