1
<?xml version="1.0" encoding="ascii"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>epydoc.apidoc.DocIndex</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th> <a
19
href="epydoc-module.html">Home</a> </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
41
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
45
<a href="epydoc-module.html">Package epydoc</a> ::
46
<a href="epydoc.apidoc-module.html">Module apidoc</a> ::
51
<table cellpadding="0" cellspacing="0">
52
<!-- hide/show private -->
53
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
54
onclick="toggle_private();">hide private</a>]</span></td></tr>
55
<tr><td align="right"><span class="options"
56
>[<a href="frames.html" target="_top">frames</a
57
>] | <a href="epydoc.apidoc.DocIndex-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<h1 class="epydoc">Class DocIndex</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex">source code</a></span></p>
65
<p>[xx] out of date.</p>
66
<p>An index that .. hmm... it *can't* be used to access some things, cuz
67
they're not at the root level. Do I want to add them or what? And if so,
68
then I have a sort of a new top level. hmm.. so basically the question
69
is what to do with a name that's not in the root var's name space. 2
73
entirely outside (eg os.path)
76
inside but not known (eg a submodule that we didn't look at?)
79
container of current thing not examined?
82
<p>An index of all the <code>APIDoc</code> objects that can be reached
83
from a root set of <code>ValueDoc</code>s.</p>
84
<p>The members of this index can be accessed by dotted name. In
85
particular, <code>DocIndex</code> defines two mappings, accessed via the
86
<a href="epydoc.apidoc.DocIndex-class.html#get_vardoc"
87
class="link">get_vardoc()</a> and <a
88
href="epydoc.apidoc.DocIndex-class.html#get_valdoc"
89
class="link">get_valdoc()</a> methods, which can be used to access
90
<code>VariableDoc</code>s or <code>ValueDoc</code>s respectively by name.
91
(Two separate mappings are necessary because a single name can be used to
92
refer to both a variable and to the value contained by that
94
<p>Additionally, the index defines two sets of <code>ValueDoc</code>s:
95
"reachable <code>ValueDoc</code>s" and "contained
96
<code>ValueDoc</code>s". The <a
97
name="index-reachable_ValueDocs"></a><i class="indexterm">reachable
98
<code>ValueDoc</code>s</i> are defined as the set of all
99
<code>ValueDoc</code>s that can be reached from the root set by following
100
<i>any</i> sequence of pointers to <code>ValueDoc</code>s or
101
<code>VariableDoc</code>s. The <a name="index-contained_ValueDocs"></a><i
102
class="indexterm">contained <code>ValueDoc</code>s</i> are defined as the
103
set of all <code>ValueDoc</code>s that can be reached from the root set
104
by following only the <code>ValueDoc</code> pointers defined by
105
non-imported <code>VariableDoc</code>s. For example, if the root set
106
contains a module <code>m</code>, then the contained
107
<code>ValueDoc</code>s includes the <code>ValueDoc</code>s for any
108
functions, variables, or classes defined in that module, as well as
109
methods and variables defined in classes defined in the module. The
110
reachable <code>ValueDoc</code>s includes all of those
111
<code>ValueDoc</code>s, as well as <code>ValueDoc</code>s for any values
112
imported into the module, and base classes for classes defined in the
115
<!-- ==================== INSTANCE METHODS ==================== -->
116
<a name="section-InstanceMethods"></a>
117
<table class="summary" border="1" cellpadding="3"
118
cellspacing="0" width="100%" bgcolor="white">
119
<tr bgcolor="#70b0f0" class="table-header">
120
<td colspan="2" class="table-header">
121
<table border="0" cellpadding="0" cellspacing="0" width="100%">
123
<td align="left"><span class="table-header">Instance Methods</span></td>
124
<td align="right" valign="top"
125
><span class="options">[<a href="#section-InstanceMethods"
126
class="privatelink" onclick="toggle_private();"
127
>hide private</a>]</span></td>
133
<td width="15%" align="right" valign="top" class="summary">
134
<span class="summary-type"> </span>
135
</td><td class="summary">
136
<table width="100%" cellpadding="0" cellspacing="0" border="0">
138
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
139
<span class="summary-sig-arg">root</span>)</span><br />
140
Create a new documentation index, based on the given root set of
141
<code>ValueDoc</code>s.</td>
142
<td align="right" valign="top">
143
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.__init__">source code</a></span>
144
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___2-summary-div');return false;">call graph</a></span>
148
<div style="display:none" id="call_graph_for___init___2-summary-div"><center>
149
<table border="0" cellpadding="0" cellspacing="0">
150
<tr><td><center> <map id="call_graph_for___init___2" name="call_graph_for___init___2">
151
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#__init__" title="__init__()" alt="" coords="297,34,393,66" />
152
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" title="_get_module_classes()" alt="" coords="448,6,643,38" />
153
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="444,62,647,94" />
154
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,34,248,66" />
156
<img src="call_graph_for___init___2.gif" alt='' usemap="#call_graph_for___init___2" ismap="ismap" class="graph-without-title" />
158
<tr><th>Call Graph</th></tr>
165
<td width="15%" align="right" valign="top" class="summary">
166
<span class="summary-type"> </span>
167
</td><td class="summary">
168
<table width="100%" cellpadding="0" cellspacing="0" border="0">
170
<td><span class="summary-sig"><a name="get_vardoc"></a><span class="summary-sig-name">get_vardoc</span>(<span class="summary-sig-arg">self</span>,
171
<span class="summary-sig-arg">name</span>)</span><br />
172
Return the <code>VariableDoc</code> with the given name, or
173
<code>None</code> if this index does not contain a
174
<code>VariableDoc</code> with the given name.</td>
175
<td align="right" valign="top">
176
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.get_vardoc">source code</a></span>
177
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_vardoc-summary-div');return false;">call graph</a></span>
181
<div style="display:none" id="call_graph_for_get_vardoc-summary-div"><center>
182
<table border="0" cellpadding="0" cellspacing="0">
183
<tr><td><center> <map id="call_graph_for_get_vardoc" name="call_graph_for_get_vardoc">
184
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get" title="_get()" alt="" coords="740,62,807,94" />
185
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="find()" alt="" coords="233,6,297,38" />
186
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_vardoc" title="get_vardoc()" alt="" coords="573,62,691,94" />
187
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private" title="docwriter.html.HTMLWriter._doc_or_ancestor_is_private()" alt="" coords="31,62,500,94" />
188
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="docwriter.html._HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="7,118,524,150" />
190
<img src="call_graph_for_get_vardoc.gif" alt='' usemap="#call_graph_for_get_vardoc" ismap="ismap" class="graph-without-title" />
192
<tr><th>Call Graph</th></tr>
199
<td width="15%" align="right" valign="top" class="summary">
200
<span class="summary-type"> </span>
201
</td><td class="summary">
202
<table width="100%" cellpadding="0" cellspacing="0" border="0">
204
<td><span class="summary-sig"><a name="get_valdoc"></a><span class="summary-sig-name">get_valdoc</span>(<span class="summary-sig-arg">self</span>,
205
<span class="summary-sig-arg">name</span>)</span><br />
206
Return the <code>ValueDoc</code> with the given name, or
207
<code>None</code> if this index does not contain a
208
<code>ValueDoc</code> with the given name.</td>
209
<td align="right" valign="top">
210
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.get_valdoc">source code</a></span>
211
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_valdoc-summary-div');return false;">call graph</a></span>
215
<div style="display:none" id="call_graph_for_get_valdoc-summary-div"><center>
216
<table border="0" cellpadding="0" cellspacing="0">
217
<tr><td><center> <map id="call_graph_for_get_valdoc" name="call_graph_for_get_valdoc">
218
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get" title="_get()" alt="" coords="690,118,756,150" />
219
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="container()" alt="" coords="188,6,292,38" />
220
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="get_valdoc()" alt="" coords="524,118,639,150" />
221
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="find()" alt="" coords="208,62,272,94" />
222
<area shape="rect" href="epydoc.docstringparser-module.html#user_docfields" title="docstringparser.user_docfields()" alt="" coords="110,118,371,150" />
223
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_doc_or_ancestor_is_private" title="docwriter.html.HTMLWriter._doc_or_ancestor_is_private()" alt="" coords="6,174,475,206" />
224
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="docwriter.html.HTMLWriter._url()" alt="" coords="98,230,383,262" />
226
<img src="call_graph_for_get_valdoc.gif" alt='' usemap="#call_graph_for_get_valdoc" ismap="ismap" class="graph-without-title" />
228
<tr><th>Call Graph</th></tr>
235
<td width="15%" align="right" valign="top" class="summary">
236
<span class="summary-type"> </span>
237
</td><td class="summary">
238
<table width="100%" cellpadding="0" cellspacing="0" border="0">
240
<td><span class="summary-sig"><a name="_get"></a><span class="summary-sig-name">_get</span>(<span class="summary-sig-arg">self</span>,
241
<span class="summary-sig-arg">name</span>)</span><br />
242
A helper function that's used to implement <a
243
href="epydoc.apidoc.DocIndex-class.html#get_vardoc"
244
class="link">get_vardoc()</a> and <a
245
href="epydoc.apidoc.DocIndex-class.html#get_valdoc"
246
class="link">get_valdoc()</a>.</td>
247
<td align="right" valign="top">
248
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._get">source code</a></span>
249
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get-summary-div');return false;">call graph</a></span>
253
<div style="display:none" id="call_graph_for__get-summary-div"><center>
254
<table border="0" cellpadding="0" cellspacing="0">
255
<tr><td><center> <map id="call_graph_for__get" name="call_graph_for__get">
256
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get" title="_get()" alt="" coords="172,90,239,122" />
257
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_from" title="_get_from()" alt="" coords="347,6,459,38" />
258
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="290,62,516,94" />
259
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__hash__" title="DottedName.__hash__()" alt="" coords="300,118,506,150" />
260
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#dominates" title="DottedName.dominates()" alt="" coords="298,174,508,206" />
261
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="get_valdoc()" alt="" coords="7,62,122,94" />
262
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_vardoc" title="get_vardoc()" alt="" coords="6,118,123,150" />
264
<img src="call_graph_for__get.gif" alt='' usemap="#call_graph_for__get" ismap="ismap" class="graph-without-title" />
266
<tr><th>Call Graph</th></tr>
273
<td width="15%" align="right" valign="top" class="summary">
274
<span class="summary-type"> </span>
275
</td><td class="summary">
276
<table width="100%" cellpadding="0" cellspacing="0" border="0">
278
<td><span class="summary-sig"><a name="_get_from"></a><span class="summary-sig-name">_get_from</span>(<span class="summary-sig-arg">self</span>,
279
<span class="summary-sig-arg">val_doc</span>,
280
<span class="summary-sig-arg">identifier</span>)</span></td>
281
<td align="right" valign="top">
282
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._get_from">source code</a></span>
283
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get_from-summary-div');return false;">call graph</a></span>
287
<div style="display:none" id="call_graph_for__get_from-summary-div"><center>
288
<table border="0" cellpadding="0" cellspacing="0">
289
<tr><td><center> <map id="call_graph_for__get_from" name="call_graph_for__get_from">
290
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get" title="_get()" alt="" coords="7,6,73,38" />
291
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_from" title="_get_from()" alt="" coords="124,6,236,38" />
292
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="287,6,513,38" />
294
<img src="call_graph_for__get_from.gif" alt='' usemap="#call_graph_for__get_from" ismap="ismap" class="graph-without-title" />
296
<tr><th>Call Graph</th></tr>
303
<td width="15%" align="right" valign="top" class="summary">
304
<span class="summary-type"> </span>
305
</td><td class="summary">
306
<table width="100%" cellpadding="0" cellspacing="0" border="0">
308
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#find" class="summary-sig-name">find</a>(<span class="summary-sig-arg">self</span>,
309
<span class="summary-sig-arg">name</span>,
310
<span class="summary-sig-arg">context</span>)</span><br />
311
Look for an <code>APIDoc</code> named <code>name</code>, relative to
312
<code>context</code>.</td>
313
<td align="right" valign="top">
314
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.find">source code</a></span>
315
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_find-summary-div');return false;">call graph</a></span>
319
<div style="display:none" id="call_graph_for_find-summary-div"><center>
320
<table border="0" cellpadding="0" cellspacing="0">
321
<tr><td><center> <map id="call_graph_for_find" name="call_graph_for_find">
322
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="find()" alt="" coords="579,174,643,206" />
323
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="get_valdoc()" alt="" coords="748,6,863,38" />
324
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_vardoc" title="get_vardoc()" alt="" coords="747,62,864,94" />
325
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__add__" title="DottedName.__add__()" alt="" coords="705,118,905,150" />
326
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="692,174,919,206" />
327
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="DottedName.__init__()" alt="" coords="707,230,904,262" />
328
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__radd__" title="DottedName.__radd__()" alt="" coords="703,286,908,318" />
329
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="RoutineDoc.all_args()" alt="" coords="712,342,899,374" />
330
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_add_attribute_edge" title="docwriter.dotgraph.DotGraphUmlClassNode._add_attribute_edge()" alt="" coords="5,6,531,38" />
331
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#import_graph" title="docwriter.dotgraph.import_graph()" alt="" coords="128,62,408,94" />
332
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="docwriter.html._HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="9,118,527,150" />
333
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#url_for" title="docwriter.html._HTMLDocstringLinker.url_for()" alt="" coords="73,174,463,206" />
334
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_build_graph" title="markup.epytext.ParsedEpytextDocstring._build_graph()" alt="" coords="48,230,488,262" />
335
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_classtree" title="markup.restructuredtext._construct_classtree()" alt="" coords="84,286,452,318" />
336
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_packagetree" title="markup.restructuredtext._construct_packagetree()" alt="" coords="72,342,464,374" />
338
<img src="call_graph_for_find.gif" alt='' usemap="#call_graph_for_find" ismap="ismap" class="graph-without-title" />
340
<tr><th>Call Graph</th></tr>
347
<td width="15%" align="right" valign="top" class="summary">
348
<span class="summary-type"><code>dict</code> from <code>str</code> to <a
349
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a> or
350
<code>list</code></span>
351
</td><td class="summary">
352
<table width="100%" cellpadding="0" cellspacing="0" border="0">
354
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" class="summary-sig-name" onclick="show_private();">_get_module_classes</a>(<span class="summary-sig-arg">self</span>,
355
<span class="summary-sig-arg">docs</span>)</span><br />
356
Gather all the classes defined in a list of modules.</td>
357
<td align="right" valign="top">
358
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._get_module_classes">source code</a></span>
359
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get_module_cla-summary-div');return false;">call graph</a></span>
363
<div style="display:none" id="call_graph_for__get_module_cla-summary-div"><center>
364
<table border="0" cellpadding="0" cellspacing="0">
365
<tr><td><center> <map id="call_graph_for__get_module_cla" name="call_graph_for__get_module_cla">
366
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="424,6,595,38" />
367
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#__init__" title="__init__()" alt="" coords="7,62,103,94" />
368
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" title="_get_module_classes()" alt="" coords="152,62,347,94" />
369
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="408,62,611,94" />
370
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="396,118,623,150" />
372
<img src="call_graph_for__get_module_cla.gif" alt='' usemap="#call_graph_for__get_module_cla" ismap="ismap" class="graph-without-title" />
374
<tr><th>Call Graph</th></tr>
381
<td width="15%" align="right" valign="top" class="summary">
382
<span class="summary-type"> </span>
383
</td><td class="summary">
384
<table width="100%" cellpadding="0" cellspacing="0" border="0">
386
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" class="summary-sig-name">reachable_valdocs</a>(<span class="summary-sig-arg">self</span>,
387
<span class="summary-sig-arg">**filters</span>)</span><br />
388
Return a list of all <code>ValueDoc</code>s that can be reached,
389
directly or indirectly from this <code>DocIndex</code>'s root set.</td>
390
<td align="right" valign="top">
391
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.reachable_valdocs">source code</a></span>
392
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_reachable_valdo_2-summary-div');return false;">call graph</a></span>
396
<div style="display:none" id="call_graph_for_reachable_valdo_2-summary-div"><center>
397
<table border="0" cellpadding="0" cellspacing="0">
398
<tr><td><center> <map id="call_graph_for_reachable_valdo_2" name="call_graph_for_reachable_valdo_2">
399
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="371,34,544,66" />
400
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="592,34,766,66" />
401
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="43,6,286,38" />
402
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="docwriter.html.HTMLWriter.__init__()" alt="" coords="6,62,323,94" />
404
<img src="call_graph_for_reachable_valdo_2.gif" alt='' usemap="#call_graph_for_reachable_valdo_2" ismap="ismap" class="graph-without-title" />
406
<tr><th>Call Graph</th></tr>
413
<td width="15%" align="right" valign="top" class="summary">
414
<span class="summary-type"> </span>
415
</td><td class="summary">
416
<table width="100%" cellpadding="0" cellspacing="0" border="0">
418
<td><span class="summary-sig"><a name="container"></a><span class="summary-sig-name">container</span>(<span class="summary-sig-arg">self</span>,
419
<span class="summary-sig-arg">api_doc</span>)</span><br />
420
Return the <code>ValueDoc</code> that contains the given
421
<code>APIDoc</code>, or <code>None</code> if its container is not in
423
<td align="right" valign="top">
424
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.container">source code</a></span>
425
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_container-summary-div');return false;">call graph</a></span>
429
<div style="display:none" id="call_graph_for_container-summary-div"><center>
430
<table border="0" cellpadding="0" cellspacing="0">
431
<tr><td><center> <map id="call_graph_for_container" name="call_graph_for_container">
432
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="APIDoc.__hash__()" alt="" coords="690,90,860,122" />
433
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="container()" alt="" coords="520,146,624,178" />
434
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="get_valdoc()" alt="" coords="718,146,832,178" />
435
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#container" title="DottedName.container()" alt="" coords="674,202,876,234" />
436
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="docwriter.html.HTMLWriter._url()" alt="" coords="96,6,382,38" />
437
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="docwriter.html.HTMLWriter._val_is_public()" alt="" coords="58,62,420,94" />
438
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="docwriter.html.HTMLWriter.breadcrumbs()" alt="" coords="64,118,414,150" />
439
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#build_identifier_index" title="docwriter.html.HTMLWriter.build_identifier_index()" alt="" coords="28,174,450,206" />
440
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_project_toc" title="docwriter.html.HTMLWriter.write_project_toc()" alt="" coords="46,230,432,262" />
441
<area shape="rect" href="epydoc.docwriter.html_colorize.PythonSourceColorizer-class.html#doc_kind" title="docwriter.html_colorize.PythonSourceColorizer.doc_kind()" alt="" coords="6,286,472,318" />
443
<img src="call_graph_for_container.gif" alt='' usemap="#call_graph_for_container" ismap="ismap" class="graph-without-title" />
445
<tr><th>Call Graph</th></tr>
452
<td width="15%" align="right" valign="top" class="summary">
453
<span class="summary-type"> </span>
454
</td><td class="summary">
455
<table width="100%" cellpadding="0" cellspacing="0" border="0">
457
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#read_profiling_info" class="summary-sig-name">read_profiling_info</a>(<span class="summary-sig-arg">self</span>,
458
<span class="summary-sig-arg">profile_stats</span>)</span><br />
459
Initialize the <a href="epydoc.apidoc.DocIndex-class.html#callers"
460
class="link">callers</a> and <a
461
href="epydoc.apidoc.DocIndex-class.html#callees"
462
class="link">callees</a> variables, given a <code>Stat</code> object
463
from the <code>pstats</code> module.</td>
464
<td align="right" valign="top">
465
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.read_profiling_info">source code</a></span>
474
<td width="15%" align="right" valign="top" class="summary">
475
<span class="summary-type"> </span>
476
</td><td class="summary">
477
<table width="100%" cellpadding="0" cellspacing="0" border="0">
479
<td><span class="summary-sig"><a href="epydoc.apidoc.DocIndex-class.html#_update_funcid_to_doc" class="summary-sig-name" onclick="show_private();">_update_funcid_to_doc</a>(<span class="summary-sig-arg">self</span>,
480
<span class="summary-sig-arg">profile_stats</span>)</span><br />
481
Update the dictionary mapping from <code>pstat.Stat</code> funciton
482
ids to <code>RoutineDoc</code>s.</td>
483
<td align="right" valign="top">
484
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._update_funcid_to_doc">source code</a></span>
493
<!-- ==================== INSTANCE VARIABLES ==================== -->
494
<a name="section-InstanceVariables"></a>
495
<table class="summary" border="1" cellpadding="3"
496
cellspacing="0" width="100%" bgcolor="white">
497
<tr bgcolor="#70b0f0" class="table-header">
498
<td colspan="2" class="table-header">
499
<table border="0" cellpadding="0" cellspacing="0" width="100%">
501
<td align="left"><span class="table-header">Instance Variables</span></td>
502
<td align="right" valign="top"
503
><span class="options">[<a href="#section-InstanceVariables"
504
class="privatelink" onclick="toggle_private();"
505
>hide private</a>]</span></td>
511
<td width="15%" align="right" valign="top" class="summary">
512
<span class="summary-type"><code>list</code></span>
513
</td><td class="summary">
514
<a name="root"></a><span class="summary-name">root</span><br />
515
The list of <code>ValueDoc</code>s to document.
519
<td width="15%" align="right" valign="top" class="summary">
520
<span class="summary-type"><code>dict</code> from <code>str</code> to <a
521
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a> or
522
<code>list</code></span>
523
</td><td class="summary">
524
<a href="epydoc.apidoc.DocIndex-class.html#mlclasses" class="summary-name">mlclasses</a><br />
525
A mapping from class names to <a
526
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a>.
530
<td width="15%" align="right" valign="top" class="summary">
531
<span class="summary-type"><code>list</code> of <a href="epydoc.apidoc.RoutineDoc-class.html"
532
class="link">RoutineDoc</a></span>
533
</td><td class="summary">
534
<a href="epydoc.apidoc.DocIndex-class.html#callers" class="summary-name">callers</a><br />
535
A dictionary mapping from <code>RoutineDoc</code>s in this index to
536
lists of <code>RoutineDoc</code>s for the routine's callers.
540
<td width="15%" align="right" valign="top" class="summary">
541
<span class="summary-type"><code>list</code> of <a href="epydoc.apidoc.RoutineDoc-class.html"
542
class="link">RoutineDoc</a></span>
543
</td><td class="summary">
544
<a href="epydoc.apidoc.DocIndex-class.html#callees" class="summary-name">callees</a><br />
545
A dictionary mapping from <code>RoutineDoc</code>s in this index to
546
lists of <code>RoutineDoc</code>s for the routine's callees.
550
<td width="15%" align="right" valign="top" class="summary">
551
<span class="summary-type"> </span>
552
</td><td class="summary">
553
<a href="epydoc.apidoc.DocIndex-class.html#_funcid_to_doc" class="summary-name" onclick="show_private();">_funcid_to_doc</a><br />
554
A mapping from <code>profile</code> function ids to corresponding
555
<code>APIDoc</code> objects.
559
<td width="15%" align="right" valign="top" class="summary">
560
<span class="summary-type"> </span>
561
</td><td class="summary">
562
<a name="_container_cache"></a><span class="summary-name">_container_cache</span><br />
563
A cache for the <a href="epydoc.apidoc.DocIndex-class.html#container"
564
class="link">container()</a> method, to increase speed.
568
<td width="15%" align="right" valign="top" class="summary">
569
<span class="summary-type"> </span>
570
</td><td class="summary">
571
<a name="_get_cache"></a><span class="summary-name">_get_cache</span><br />
573
href="epydoc.apidoc.DocIndex-class.html#get_vardoc"
574
class="link">get_vardoc()</a> and <a
575
href="epydoc.apidoc.DocIndex-class.html#get_valdoc"
576
class="link">get_valdoc()</a> methods, to increase speed.
580
<!-- ==================== METHOD DETAILS ==================== -->
581
<a name="section-MethodDetails"></a>
582
<table class="details" border="1" cellpadding="3"
583
cellspacing="0" width="100%" bgcolor="white">
584
<tr bgcolor="#70b0f0" class="table-header">
585
<td colspan="2" class="table-header">
586
<table border="0" cellpadding="0" cellspacing="0" width="100%">
588
<td align="left"><span class="table-header">Method Details</span></td>
589
<td align="right" valign="top"
590
><span class="options">[<a href="#section-MethodDetails"
591
class="privatelink" onclick="toggle_private();"
592
>hide private</a>]</span></td>
598
<a name="__init__"></a>
600
<table class="details" border="1" cellpadding="3"
601
cellspacing="0" width="100%" bgcolor="white">
603
<table width="100%" cellpadding="0" cellspacing="0" border="0">
604
<tr valign="top"><td>
605
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
606
<span class="sig-arg">root</span>)</span>
607
<br /><em class="fname">(Constructor)</em>
609
</td><td align="right" valign="top"
610
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.__init__">source code</a></span>
611
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___2-div');return false;">call graph</a></span> </td>
613
<div style="display:none" id="call_graph_for___init___2-div"><center>
614
<table border="0" cellpadding="0" cellspacing="0">
615
<tr><td><center> <map id="call_graph_for___init___2" name="call_graph_for___init___2">
616
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#__init__" title="__init__()" alt="" coords="297,34,393,66" />
617
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" title="_get_module_classes()" alt="" coords="448,6,643,38" />
618
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="444,62,647,94" />
619
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="5,34,248,66" />
621
<img src="call_graph_for___init___2.gif" alt='' usemap="#call_graph_for___init___2" ismap="ismap" class="graph-without-title" />
623
<tr><th>Call Graph</th></tr>
627
<p>Create a new documentation index, based on the given root set of
628
<code>ValueDoc</code>s. If any <code>APIDoc</code>s reachable from the
629
root set does not have a canonical name, then it will be assigned one.
633
<dd><ul class="nomargin-top">
634
<li><strong class="pname"><code>root</code></strong> - A list of <code>ValueDoc</code>s.</li>
641
<table class="details" border="1" cellpadding="3"
642
cellspacing="0" width="100%" bgcolor="white">
644
<table width="100%" cellpadding="0" cellspacing="0" border="0">
645
<tr valign="top"><td>
646
<h3 class="epydoc"><span class="sig"><span class="sig-name">find</span>(<span class="sig-arg">self</span>,
647
<span class="sig-arg">name</span>,
648
<span class="sig-arg">context</span>)</span>
650
</td><td align="right" valign="top"
651
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.find">source code</a></span>
652
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_find-div');return false;">call graph</a></span> </td>
654
<div style="display:none" id="call_graph_for_find-div"><center>
655
<table border="0" cellpadding="0" cellspacing="0">
656
<tr><td><center> <map id="call_graph_for_find" name="call_graph_for_find">
657
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#find" title="find()" alt="" coords="579,174,643,206" />
658
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_valdoc" title="get_valdoc()" alt="" coords="748,6,863,38" />
659
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#get_vardoc" title="get_vardoc()" alt="" coords="747,62,864,94" />
660
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__add__" title="DottedName.__add__()" alt="" coords="705,118,905,150" />
661
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="692,174,919,206" />
662
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__init__" title="DottedName.__init__()" alt="" coords="707,230,904,262" />
663
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__radd__" title="DottedName.__radd__()" alt="" coords="703,286,908,318" />
664
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#all_args" title="RoutineDoc.all_args()" alt="" coords="712,342,899,374" />
665
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_add_attribute_edge" title="docwriter.dotgraph.DotGraphUmlClassNode._add_attribute_edge()" alt="" coords="5,6,531,38" />
666
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#import_graph" title="docwriter.dotgraph.import_graph()" alt="" coords="128,62,408,94" />
667
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="docwriter.html._HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="9,118,527,150" />
668
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#url_for" title="docwriter.html._HTMLDocstringLinker.url_for()" alt="" coords="73,174,463,206" />
669
<area shape="rect" href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html#_build_graph" title="markup.epytext.ParsedEpytextDocstring._build_graph()" alt="" coords="48,230,488,262" />
670
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_classtree" title="markup.restructuredtext._construct_classtree()" alt="" coords="84,286,452,318" />
671
<area shape="rect" href="epydoc.markup.restructuredtext-module.html#_construct_packagetree" title="markup.restructuredtext._construct_packagetree()" alt="" coords="72,342,464,374" />
673
<img src="call_graph_for_find.gif" alt='' usemap="#call_graph_for_find" ismap="ismap" class="graph-without-title" />
675
<tr><th>Call Graph</th></tr>
679
<p>Look for an <code>APIDoc</code> named <code>name</code>, relative to
680
<code>context</code>. Return the <code>APIDoc</code> if one is found;
681
otherwise, return <code>None</code>. <code>find</code> looks in the
682
following places, in order:</p>
685
Function parameters (if one matches, return <code>None</code>)
688
All enclosing namespaces, from closest to furthest.
691
If <code>name</code> starts with <code>'self'</code>, then strip it
692
off and look for the remaining part of the name using
702
Classes at module level (if the name is not ambiguous)
707
<dd><ul class="nomargin-top">
708
<li><strong class="pname"><code>name</code></strong> (<code>str</code> or <a href="epydoc.apidoc.DottedName-class.html"
709
class="link">DottedName</a>)</li>
710
<li><strong class="pname"><code>context</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>)</li>
715
<a name="_get_module_classes"></a>
716
<div class="private">
717
<table class="details" border="1" cellpadding="3"
718
cellspacing="0" width="100%" bgcolor="white">
720
<table width="100%" cellpadding="0" cellspacing="0" border="0">
721
<tr valign="top"><td>
722
<h3 class="epydoc"><span class="sig"><span class="sig-name">_get_module_classes</span>(<span class="sig-arg">self</span>,
723
<span class="sig-arg">docs</span>)</span>
725
</td><td align="right" valign="top"
726
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._get_module_classes">source code</a></span>
727
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for__get_module_cla-div');return false;">call graph</a></span> </td>
729
<div style="display:none" id="call_graph_for__get_module_cla-div"><center>
730
<table border="0" cellpadding="0" cellspacing="0">
731
<tr><td><center> <map id="call_graph_for__get_module_cla" name="call_graph_for__get_module_cla">
732
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="APIDoc.__cmp__()" alt="" coords="424,6,595,38" />
733
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#__init__" title="__init__()" alt="" coords="7,62,103,94" />
734
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" title="_get_module_classes()" alt="" coords="152,62,347,94" />
735
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__cmp__" title="DottedName.__cmp__()" alt="" coords="408,62,611,94" />
736
<area shape="rect" href="epydoc.apidoc.DottedName-class.html#__getitem__" title="DottedName.__getitem__()" alt="" coords="396,118,623,150" />
738
<img src="call_graph_for__get_module_cla.gif" alt='' usemap="#call_graph_for__get_module_cla" ismap="ismap" class="graph-without-title" />
740
<tr><th>Call Graph</th></tr>
744
<p>Gather all the classes defined in a list of modules.</p>
745
<p>Very often people refers to classes only by class name, even if they
746
are not imported in the namespace. Linking to such classes will fail if
747
we look for them only in nested namespaces. Allow them to retrieve only
751
<dd><ul class="nomargin-top">
752
<li><strong class="pname"><code>docs</code></strong> (<code>list</code> of <code>APIDoc</code>) - containers of the objects to collect</li>
754
<dt>Returns: <code>dict</code> from <code>str</code> to <a
755
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a> or
756
<code>list</code></dt>
757
<dd>mapping from objects name to the object(s) with that name</dd>
761
<a name="reachable_valdocs"></a>
763
<table class="details" border="1" cellpadding="3"
764
cellspacing="0" width="100%" bgcolor="white">
766
<table width="100%" cellpadding="0" cellspacing="0" border="0">
767
<tr valign="top"><td>
768
<h3 class="epydoc"><span class="sig"><span class="sig-name">reachable_valdocs</span>(<span class="sig-arg">self</span>,
769
<span class="sig-arg">**filters</span>)</span>
771
</td><td align="right" valign="top"
772
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.reachable_valdocs">source code</a></span>
773
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_reachable_valdo_2-div');return false;">call graph</a></span> </td>
775
<div style="display:none" id="call_graph_for_reachable_valdo_2-div"><center>
776
<table border="0" cellpadding="0" cellspacing="0">
777
<tr><td><center> <map id="call_graph_for_reachable_valdo_2" name="call_graph_for_reachable_valdo_2">
778
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="371,34,544,66" />
779
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="592,34,766,66" />
780
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="43,6,286,38" />
781
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="docwriter.html.HTMLWriter.__init__()" alt="" coords="6,62,323,94" />
783
<img src="call_graph_for_reachable_valdo_2.gif" alt='' usemap="#call_graph_for_reachable_valdo_2" ismap="ismap" class="graph-without-title" />
785
<tr><th>Call Graph</th></tr>
789
<p>Return a list of all <code>ValueDoc</code>s that can be reached,
790
directly or indirectly from this <code>DocIndex</code>'s root set.</p>
793
<dd><ul class="nomargin-top">
794
<li><strong class="pname"><code>filters</code></strong> - A set of filters that can be used to prevent
795
<code>reachable_valdocs</code> from following specific link types
796
when looking for <code>ValueDoc</code>s that can be reached from
797
the root set. See <code>APIDoc.apidoc_links</code> for a more
798
complete description.</li>
803
<a name="read_profiling_info"></a>
805
<table class="details" border="1" cellpadding="3"
806
cellspacing="0" width="100%" bgcolor="white">
808
<table width="100%" cellpadding="0" cellspacing="0" border="0">
809
<tr valign="top"><td>
810
<h3 class="epydoc"><span class="sig"><span class="sig-name">read_profiling_info</span>(<span class="sig-arg">self</span>,
811
<span class="sig-arg">profile_stats</span>)</span>
813
</td><td align="right" valign="top"
814
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex.read_profiling_info">source code</a></span>
818
<p>Initialize the <a href="epydoc.apidoc.DocIndex-class.html#callers"
819
class="link">callers</a> and <a
820
href="epydoc.apidoc.DocIndex-class.html#callees" class="link">callees</a>
821
variables, given a <code>Stat</code> object from the <code>pstats</code>
825
<div class="fields"> <p><strong>Warning:</strong>
826
This method uses undocumented data structures inside of
827
<code>profile_stats</code>.
829
</div></td></tr></table>
831
<a name="_update_funcid_to_doc"></a>
832
<div class="private">
833
<table class="details" border="1" cellpadding="3"
834
cellspacing="0" width="100%" bgcolor="white">
836
<table width="100%" cellpadding="0" cellspacing="0" border="0">
837
<tr valign="top"><td>
838
<h3 class="epydoc"><span class="sig"><span class="sig-name">_update_funcid_to_doc</span>(<span class="sig-arg">self</span>,
839
<span class="sig-arg">profile_stats</span>)</span>
841
</td><td align="right" valign="top"
842
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#DocIndex._update_funcid_to_doc">source code</a></span>
846
<p>Update the dictionary mapping from <code>pstat.Stat</code> funciton
847
ids to <code>RoutineDoc</code>s. <code>pstat.Stat</code> function ids
848
are tuples of <code>(filename, lineno, funcname)</code>.</p>
854
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
855
<a name="section-InstanceVariableDetails"></a>
856
<table class="details" border="1" cellpadding="3"
857
cellspacing="0" width="100%" bgcolor="white">
858
<tr bgcolor="#70b0f0" class="table-header">
859
<td colspan="2" class="table-header">
860
<table border="0" cellpadding="0" cellspacing="0" width="100%">
862
<td align="left"><span class="table-header">Instance Variable Details</span></td>
863
<td align="right" valign="top"
864
><span class="options">[<a href="#section-InstanceVariableDetails"
865
class="privatelink" onclick="toggle_private();"
866
>hide private</a>]</span></td>
872
<a name="mlclasses"></a>
874
<table class="details" border="1" cellpadding="3"
875
cellspacing="0" width="100%" bgcolor="white">
877
<h3 class="epydoc">mlclasses</h3>
878
<p>A mapping from class names to <a
879
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a>.
880
Contains classes defined at module level for modules in <a
881
href="epydoc.apidoc.DocIndex-class.html#root" class="link">root</a> and
882
which can be used as fallback by <a
883
href="epydoc.apidoc.DocIndex-class.html#find" class="link">find()</a> if
884
looking in containing namespaces fails.</p>
887
<dd><code>dict</code> from <code>str</code> to <a
888
href="epydoc.apidoc.ClassDoc-class.html" class="link">ClassDoc</a> or
889
<code>list</code></dd>
893
<a name="callers"></a>
895
<table class="details" border="1" cellpadding="3"
896
cellspacing="0" width="100%" bgcolor="white">
898
<h3 class="epydoc">callers</h3>
899
<p>A dictionary mapping from <code>RoutineDoc</code>s in this index to
900
lists of <code>RoutineDoc</code>s for the routine's callers. This
901
dictionary is initialized by calling <a
902
href="epydoc.apidoc.DocIndex-class.html#read_profiling_info"
903
class="link">read_profiling_info()</a>.</p>
906
<dd><code>list</code> of <a href="epydoc.apidoc.RoutineDoc-class.html"
907
class="link">RoutineDoc</a></dd>
911
<a name="callees"></a>
913
<table class="details" border="1" cellpadding="3"
914
cellspacing="0" width="100%" bgcolor="white">
916
<h3 class="epydoc">callees</h3>
917
<p>A dictionary mapping from <code>RoutineDoc</code>s in this index to
918
lists of <code>RoutineDoc</code>s for the routine's callees. This
919
dictionary is initialized by calling <a
920
href="epydoc.apidoc.DocIndex-class.html#read_profiling_info"
921
class="link">read_profiling_info()</a>.</p>
924
<dd><code>list</code> of <a href="epydoc.apidoc.RoutineDoc-class.html"
925
class="link">RoutineDoc</a></dd>
929
<a name="_funcid_to_doc"></a>
930
<div class="private">
931
<table class="details" border="1" cellpadding="3"
932
cellspacing="0" width="100%" bgcolor="white">
934
<h3 class="epydoc">_funcid_to_doc</h3>
935
<p>A mapping from <code>profile</code> function ids to corresponding
936
<code>APIDoc</code> objects. A function id is a tuple of the form
937
<code>(filename, lineno, funcname)</code>. This is used to update the <a
938
href="epydoc.apidoc.DocIndex-class.html#callers" class="link">callers</a>
939
and <a href="epydoc.apidoc.DocIndex-class.html#callees"
940
class="link">callees</a> variables.</p>
946
<!-- ==================== NAVIGATION BAR ==================== -->
947
<table class="navbar" border="0" width="100%" cellpadding="0"
948
bgcolor="#a0c0ff" cellspacing="0">
951
<th> <a
952
href="epydoc-module.html">Home</a> </th>
955
<th> <a
956
href="module-tree.html">Trees</a> </th>
959
<th> <a
960
href="identifier-index.html">Indices</a> </th>
963
<th> <a
964
href="help.html">Help</a> </th>
966
<!-- Project homepage -->
967
<th class="navbar" align="right" width="100%">
968
<table border="0" cellpadding="0" cellspacing="0">
969
<tr><th class="navbar" align="center"
970
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
974
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
976
<td align="left" class="footer">
977
<a href="epydoc-log.html">Generated by Epydoc
978
3.0.1 on Wed Jan 30 14:07:06 2008</a>
980
<td align="right" class="footer">
981
<a target="mainFrame" href="http://epydoc.sourceforge.net"
982
>http://epydoc.sourceforge.net</a>
987
<script type="text/javascript">
989
// Private objects are initially displayed (because if
990
// javascript is turned off then we want them to be
991
// visible); but by default, we want to hide them. So hide
992
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc.apidoc.DocIndex-class.html
