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.APIDoc</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.APIDoc-class.html"
58
target="_top">no frames</a>]</span></td></tr>
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
<h1 class="epydoc">Class APIDoc</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc">source code</a></span></p>
66
<center> <map id="uml_class_diagram_for_epydoc_a" name="uml_class_diagram_for_epydoc_a">
67
<area shape="rect" href="epydoc.markup.ParsedDocstring-class.html" title="A standard intermediate representation for parsed docstrings that can be used to generate output." alt="" coords="5,374,189,411" />
68
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html" title="API documentation information about a singe Python namespace value." alt="" coords="391,435,521,472" />
69
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html" title="API documentation information about a single module." alt="" coords="340,496,444,534" />
70
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html" title="API documentation information about a single class." alt="" coords="473,496,567,534" />
71
<area shape="rect" href="epydoc.apidoc.StaticMethodDoc-class.html" title="epydoc.apidoc.StaticMethodDoc" alt="" coords="635,496,773,534" />
72
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html" title="API documentation information about a single property." alt="" coords="551,435,660,472" />
73
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html" title="API documentation information about a single routine." alt="" coords="689,435,796,472" />
74
<area shape="rect" href="epydoc.apidoc.ClassMethodDoc-class.html" title="epydoc.apidoc.ClassMethodDoc" alt="" coords="803,496,941,534" />
75
<area shape="rect" href="epydoc.docstringparser.DocstringField-class.html" title="A simple docstring field, which can be used to describe specific information about an object, such as its author or its version." alt="" coords="219,374,435,411" />
76
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring" title="The documented item's docstring." alt="" coords="332,28,705,47" />
77
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docstring_lineno" title="The line number on which the documented item's docstring begins." alt="" coords="332,47,705,66" />
78
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#other_docs" title="A flag indicating if the entire docstring body (except tags if any) is entirely included in the summary." alt="" coords="332,66,705,84" />
79
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#metadata" title="Metadata about the documented item, extracted from fields in its docstring." alt="" coords="332,84,705,103" />
80
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by" title="Information about where the information contained by this APIDoc came from." alt="" coords="332,103,705,122" />
81
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="Construct a new APIDoc object." alt="" coords="332,124,705,143" />
82
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__setattr__" title="Modify an APIDoc's attribute." alt="" coords="332,143,705,162" />
83
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__repr__" title="repr(x)" alt="" coords="332,162,705,180" />
84
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#pp" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="332,180,705,199" />
85
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__str__" title="Return a pretty-printed string representation for the information contained in this APIDoc." alt="" coords="332,199,705,218" />
86
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="Change self's class to cls." alt="" coords="332,218,705,236" />
87
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="hash(x)" alt="" coords="332,236,705,255" />
88
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="epydoc.apidoc.APIDoc.__cmp__" alt="" coords="332,255,705,274" />
89
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="Does this object deserve a box with extra details?" alt="" coords="332,274,705,292" />
90
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="Combine self and other into a merged object, such that any changes made to one will affect the other." alt="" coords="332,292,705,311" />
91
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#apidoc_links" title="Return a list of all APIDocs that are directly linked from this APIDoc (i.e., are contained or pointed to by one or more of this APIDoc's attributes.)" alt="" coords="332,311,705,330" />
92
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html" title="API documentation information for a single element of a Python program." alt="" coords="320,6,717,336" />
93
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="epydoc.apidoc.APIDoc.descr" alt="" coords="149,348,182,362" />
94
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="327,244,335,252" />
95
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#descr" title="descr" alt="" coords="107,375,115,383" />
96
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="epydoc.apidoc.APIDoc.summary" alt="" coords="223,348,279,362" />
97
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="327,283,335,291" />
98
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#summary" title="summary" alt="" coords="139,375,147,383" />
99
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="epydoc.apidoc.APIDoc.extra_docstring_fields" alt="" coords="363,348,493,362" />
100
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="376,327,384,335" />
101
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" title="extra_docstring_fields" alt="" coords="335,375,343,383" />
102
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html" title="API documentation information about a single Python variable." alt="" coords="464,374,573,411" />
103
<area shape="rect" href="epydoc.apidoc.ValueDoc-class.html" title="API documentation information about a single Python value." alt="" coords="603,374,696,411" />
104
<area shape="rect" href="epydoc.apidoc.DottedName-class.html" title="A sequence of identifiers, separated by periods, used to name a Python variable, value, or argument." alt="" coords="747,152,859,190" />
105
<area shape="rect" href="epydoc.apidoc.GenericValueDoc-class.html" title="API documentation about a 'generic' value, i.e., one that does not have its own docstring or any information other than its value and parse representation." alt="" coords="825,435,967,472" />
107
<img src="uml_class_diagram_for_epydoc_a.gif" alt='' usemap="#uml_class_diagram_for_epydoc_a" ismap="ismap" class="graph-without-title" />
111
<p>API documentation information for a single element of a Python
112
program. <code>APIDoc</code> itself is an abstract base class;
113
subclasses are used to specify what information should be recorded about
114
each type of program element. In particular, <code>APIDoc</code> has two
115
direct subclasses, <code>VariableDoc</code> for documenting variables and
116
<code>ValueDoc</code> for documenting values; and the
117
<code>ValueDoc</code> class is subclassed further for different value
119
<p>Each <code>APIDoc</code> subclass specifies the set of attributes that
120
should be used to record information about the corresponding program
121
element type. The default value for each attribute is stored in the
122
class; these default values can then be overridden with instance
123
variables. Most attributes use the special value <a
124
href="epydoc.apidoc-module.html#UNKNOWN" class="link">UNKNOWN</a> as
125
their default value, to indicate that the correct value for that
126
attribute has not yet been determined. This makes it easier to merge two
127
<code>APIDoc</code> objects that are documenting the same element (in
128
particular, to merge information about an element that was derived from
129
parsing with information that was derived from introspection).</p>
130
<p>For all attributes with boolean values, use only the constants
131
<code>True</code> and <code>False</code> to designate true and false. In
132
particular, do <i>not</i> use other values that evaluate as true or
133
false, such as <code>2</code> or <code>()</code>. This restriction makes
134
it easier to handle <code>UNKNOWN</code> values. For example, to test if
135
a boolean attribute is <code>True</code> or <code>UNKNOWN</code>, use
136
'<code>attrib in (True, UNKNOWN)</code>' or '<code>attrib is not
138
<p>Two <code>APIDoc</code> objects describing the same object can be <a
139
name="index-merged"></a><i class="indexterm">merged</i>, using the method
140
<a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite"
141
class="link">merge_and_overwrite(other)</a>. After two
142
<code>APIDoc</code>s are merged, any changes to one will be reflected in
143
the other. This is accomplished by setting the two <code>APIDoc</code>
144
objects to use a shared instance dictionary. See the documentation for
145
<a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite"
146
class="link">merge_and_overwrite</a> for more information, and some
147
important caveats about hashing.</p>
149
<!-- ==================== INSTANCE METHODS ==================== -->
150
<a name="section-InstanceMethods"></a>
151
<table class="summary" border="1" cellpadding="3"
152
cellspacing="0" width="100%" bgcolor="white">
153
<tr bgcolor="#70b0f0" class="table-header">
154
<td colspan="2" class="table-header">
155
<table border="0" cellpadding="0" cellspacing="0" width="100%">
157
<td align="left"><span class="table-header">Instance Methods</span></td>
158
<td align="right" valign="top"
159
><span class="options">[<a href="#section-InstanceMethods"
160
class="privatelink" onclick="toggle_private();"
161
>hide private</a>]</span></td>
167
<td width="15%" align="right" valign="top" class="summary">
168
<span class="summary-type"> </span>
169
</td><td class="summary">
170
<table width="100%" cellpadding="0" cellspacing="0" border="0">
172
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
173
<span class="summary-sig-arg">**kwargs</span>)</span><br />
174
Construct a new <code>APIDoc</code> object.</td>
175
<td align="right" valign="top">
176
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__init__">source code</a></span>
177
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init__-summary-div');return false;">call graph</a></span>
181
<div style="display:none" id="call_graph_for___init__-summary-div"><center>
182
<table border="0" cellpadding="0" cellspacing="0">
183
<tr><td><center> <map id="call_graph_for___init__" name="call_graph_for___init__">
184
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="__init__()" alt="" coords="396,258,492,290" />
185
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="specialize_to()" alt="" coords="111,6,242,38" />
186
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="NamespaceDoc.__init__()" alt="" coords="67,62,286,94" />
187
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="VariableDoc.__init__()" alt="" coords="78,118,275,150" />
188
<area shape="rect" href="epydoc.docintrospecter-module.html#_get_valuedoc" title="docintrospecter._get_valuedoc()" alt="" coords="46,174,307,206" />
189
<area shape="rect" href="epydoc.docparser-module.html#apply_decorator" title="docparser.apply_decorator()" alt="" coords="60,230,292,262" />
190
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="docparser.init_arglist()" alt="" coords="80,286,272,318" />
191
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="docparser.lookup_value()" alt="" coords="71,342,282,374" />
192
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="docparser.process_funcdef()" alt="" coords="60,398,292,430" />
193
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="docparser.rhs_to_valuedoc()" alt="" coords="59,454,294,486" />
194
<area shape="rect" href="epydoc.docstringparser-module.html#parse_function_signature" title="docstringparser.parse_function_signature()" alt="" coords="6,510,347,542" />
196
<img src="call_graph_for___init__.gif" alt='' usemap="#call_graph_for___init__" ismap="ismap" class="graph-without-title" />
198
<tr><th>Call Graph</th></tr>
205
<td width="15%" align="right" valign="top" class="summary">
206
<span class="summary-type"> </span>
207
</td><td class="summary">
208
<table width="100%" cellpadding="0" cellspacing="0" border="0">
210
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#_debug_setattr" class="summary-sig-name" onclick="show_private();">_debug_setattr</a>(<span class="summary-sig-arg">self</span>,
211
<span class="summary-sig-arg">attr</span>,
212
<span class="summary-sig-arg">val</span>)</span><br />
213
Modify an <code>APIDoc</code>'s attribute.</td>
214
<td align="right" valign="top">
215
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc._debug_setattr">source code</a></span>
224
<td width="15%" align="right" valign="top" class="summary">
225
<span class="summary-type"> </span>
226
</td><td class="summary">
227
<table width="100%" cellpadding="0" cellspacing="0" border="0">
229
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#__setattr__" class="summary-sig-name">__setattr__</a>(<span class="summary-sig-arg">self</span>,
230
<span class="summary-sig-arg">attr</span>,
231
<span class="summary-sig-arg">val</span>)</span><br />
232
Modify an <code>APIDoc</code>'s attribute.</td>
233
<td align="right" valign="top">
234
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc._debug_setattr">source code</a></span>
243
<td width="15%" align="right" valign="top" class="summary">
244
<span class="summary-type"> </span>
245
</td><td class="summary">
246
<table width="100%" cellpadding="0" cellspacing="0" border="0">
248
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
250
<td align="right" valign="top">
251
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__repr__">source code</a></span>
260
<td width="15%" align="right" valign="top" class="summary">
261
<span class="summary-type"> </span>
262
</td><td class="summary">
263
<table width="100%" cellpadding="0" cellspacing="0" border="0">
265
<td><span class="summary-sig"><a name="pp"></a><span class="summary-sig-name">pp</span>(<span class="summary-sig-arg">self</span>,
266
<span class="summary-sig-arg">doublespace</span>=<span class="summary-sig-default">0</span>,
267
<span class="summary-sig-arg">depth</span>=<span class="summary-sig-default">5</span>,
268
<span class="summary-sig-arg">exclude</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
269
<span class="summary-sig-arg">include</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>)</span><br />
270
Return a pretty-printed string representation for the information
271
contained in this <code>APIDoc</code>.</td>
272
<td align="right" valign="top">
273
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.pp">source code</a></span>
282
<td width="15%" align="right" valign="top" class="summary">
283
<span class="summary-type"> </span>
284
</td><td class="summary">
285
<table width="100%" cellpadding="0" cellspacing="0" border="0">
287
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>,
288
<span class="summary-sig-arg">doublespace</span>=<span class="summary-sig-default">0</span>,
289
<span class="summary-sig-arg">depth</span>=<span class="summary-sig-default">5</span>,
290
<span class="summary-sig-arg">exclude</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
291
<span class="summary-sig-arg">include</span>=<span class="summary-sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>)</span><br />
292
Return a pretty-printed string representation for the information
293
contained in this <code>APIDoc</code>.</td>
294
<td align="right" valign="top">
295
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.pp">source code</a></span>
304
<td width="15%" align="right" valign="top" class="summary">
305
<span class="summary-type"> </span>
306
</td><td class="summary">
307
<table width="100%" cellpadding="0" cellspacing="0" border="0">
309
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#specialize_to" class="summary-sig-name">specialize_to</a>(<span class="summary-sig-arg">self</span>,
310
<span class="summary-sig-arg">cls</span>)</span><br />
311
Change <code>self</code>'s class to <code>cls</code>.</td>
312
<td align="right" valign="top">
313
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.specialize_to">source code</a></span>
314
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_specialize_to-summary-div');return false;">call graph</a></span>
318
<div style="display:none" id="call_graph_for_specialize_to-summary-div"><center>
319
<table border="0" cellpadding="0" cellspacing="0">
320
<tr><td><center> <map id="call_graph_for_specialize_to" name="call_graph_for_specialize_to">
321
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="__init__()" alt="" coords="596,118,692,150" />
322
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="specialize_to()" alt="" coords="353,146,484,178" />
323
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="NamespaceDoc.__init__()" alt="" coords="535,174,753,206" />
324
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="docbuilder.merge_docs()" alt="" coords="51,6,259,38" />
325
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_class" title="docintrospecter.introspect_class()" alt="" coords="19,62,291,94" />
326
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_module" title="docintrospecter.introspect_module()" alt="" coords="9,118,300,150" />
327
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_other" title="docintrospecter.introspect_other()" alt="" coords="17,174,292,206" />
328
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_property" title="docintrospecter.introspect_property()" alt="" coords="5,230,304,262" />
329
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_routine" title="docintrospecter.introspect_routine()" alt="" coords="11,286,299,318" />
331
<img src="call_graph_for_specialize_to.gif" alt='' usemap="#call_graph_for_specialize_to" ismap="ismap" class="graph-without-title" />
333
<tr><th>Call Graph</th></tr>
340
<td width="15%" align="right" valign="top" class="summary">
341
<span class="summary-type"> </span>
342
</td><td class="summary">
343
<table width="100%" cellpadding="0" cellspacing="0" border="0">
345
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#__hash__" class="summary-sig-name">__hash__</a>(<span class="summary-sig-arg">self</span>)</span><br />
347
<td align="right" valign="top">
348
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__hash__">source code</a></span>
349
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___hash__-summary-div');return false;">call graph</a></span>
353
<div style="display:none" id="call_graph_for___hash__-summary-div"><center>
354
<table border="0" cellpadding="0" cellspacing="0">
355
<tr><td><center> <map id="call_graph_for___hash__" name="call_graph_for___hash__">
356
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="__hash__()" alt="" coords="579,511,686,543" />
357
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_dfs_bases" title="ClassDoc._dfs_bases()" alt="" coords="172,7,364,39" />
358
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="DocIndex.container()" alt="" coords="178,63,359,95" />
359
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" title="NamespaceDoc._init_grouping()" alt="" coords="135,119,402,151" />
360
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="182,175,355,207" />
361
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="118,231,419,263" />
362
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="147,287,390,319" />
363
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="132,343,404,375" />
364
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_add_attribute_edge" title="docwriter.dotgraph.DotGraphUmlClassNode._add_attribute_edge()" alt="" coords="6,399,531,431" />
365
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#add_valdoc_nodes" title="docwriter.dotgraph.add_valdoc_nodes()" alt="" coords="108,455,428,487" />
366
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#class_tree_graph" title="docwriter.dotgraph.class_tree_graph()" alt="" coords="115,511,422,543" />
367
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#import_graph" title="docwriter.dotgraph.import_graph()" alt="" coords="128,567,408,599" />
368
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="docwriter.dotgraph.uml_class_tree_graph()" alt="" coords="96,623,440,655" />
369
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="docwriter.html.HTMLWriter.__init__()" alt="" coords="110,679,427,711" />
370
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="docwriter.html.HTMLWriter._url()" alt="" coords="126,735,411,767" />
371
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="docwriter.html.HTMLWriter.pysrc_url()" alt="" coords="106,791,431,823" />
372
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="docwriter.html.HTMLWriter.write_class_tree()" alt="" coords="80,847,456,879" />
373
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="docwriter.html.HTMLWriter.write_inheritance_list()" alt="" coords="60,903,476,935" />
374
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="docwriter.html.HTMLWriter.write_module_tree()" alt="" coords="71,959,466,991" />
375
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="docwriter.html.HTMLWriter.write_summary_group()" alt="" coords="56,1015,480,1047" />
377
<img src="call_graph_for___hash__.gif" alt='' usemap="#call_graph_for___hash__" ismap="ismap" class="graph-without-title" />
379
<tr><th>Call Graph</th></tr>
386
<td width="15%" align="right" valign="top" class="summary">
387
<span class="summary-type"> </span>
388
</td><td class="summary">
389
<table width="100%" cellpadding="0" cellspacing="0" border="0">
391
<td><span class="summary-sig"><a name="__cmp__"></a><span class="summary-sig-name">__cmp__</span>(<span class="summary-sig-arg">self</span>,
392
<span class="summary-sig-arg">other</span>)</span></td>
393
<td align="right" valign="top">
394
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__cmp__">source code</a></span>
395
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___cmp__-summary-div');return false;">call graph</a></span>
399
<div style="display:none" id="call_graph_for___cmp__-summary-div"><center>
400
<table border="0" cellpadding="0" cellspacing="0">
401
<tr><td><center> <map id="call_graph_for___cmp__" name="call_graph_for___cmp__">
402
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="__cmp__()" alt="" coords="575,1159,679,1191" />
403
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="merge_and_overwrite()" alt="" coords="167,11,364,43" />
404
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_c3_merge" title="ClassDoc._c3_merge()" alt="" coords="169,67,361,99" />
405
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#select_variables" title="ClassDoc.select_variables()" alt="" coords="151,123,380,155" />
406
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#_get_module_classes" title="DocIndex._get_module_classes()" alt="" coords="129,179,401,211" />
407
<area shape="rect" href="epydoc.apidoc.ModuleDoc-class.html#apidoc_links" title="ModuleDoc.apidoc_links()" alt="" coords="153,235,377,267" />
408
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#apidoc_links" title="PropertyDoc.apidoc_links()" alt="" coords="151,291,380,323" />
409
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#apidoc_links" title="VariableDoc.apidoc_links()" alt="" coords="151,347,380,379" />
410
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="157,403,373,435" />
411
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="179,459,352,491" />
412
<area shape="rect" href="epydoc.docbuilder-module.html#_report_errors" title="docbuilder._report_errors()" alt="" coords="153,515,377,547" />
413
<area shape="rect" href="epydoc.docbuilder-module.html#_unreachable_name_for" title="docbuilder._unreachable_name_for()" alt="" coords="116,571,415,603" />
414
<area shape="rect" href="epydoc.docbuilder-module.html#_var_shadows_self" title="docbuilder._var_shadows_self()" alt="" coords="135,627,396,659" />
415
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="115,683,416,715" />
416
<area shape="rect" href="epydoc.docbuilder-module.html#find_overrides" title="docbuilder.find_overrides()" alt="" coords="152,739,379,771" />
417
<area shape="rect" href="epydoc.docbuilder-module.html#inherit_docs" title="docbuilder.inherit_docs()" alt="" coords="160,795,371,827" />
418
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="docbuilder.merge_docs()" alt="" coords="161,851,369,883" />
419
<area shape="rect" href="epydoc.docintrospecter-module.html#get_value_from_filename" title="docintrospecter.get_value_from_filename()" alt="" coords="93,907,437,939" />
420
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_class" title="docintrospecter.introspect_class()" alt="" coords="129,963,401,995" />
421
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_module" title="docintrospecter.introspect_module()" alt="" coords="120,1019,411,1051" />
422
<area shape="rect" href="epydoc.docparser-module.html#_global_name" title="docparser._global_name()" alt="" coords="157,1075,373,1107" />
423
<area shape="rect" href="epydoc.docparser-module.html#_module_var_toktree" title="docparser._module_var_toktree()" alt="" coords="131,1131,400,1163" />
424
<area shape="rect" href="epydoc.docparser-module.html#lhs_is_instvar" title="docparser.lhs_is_instvar()" alt="" coords="159,1187,372,1219" />
425
<area shape="rect" href="epydoc.docparser-module.html#process_file" title="docparser.process_file()" alt="" coords="165,1243,365,1275" />
426
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#__init__" title="docwriter.dotgraph.DotGraphUmlClassNode.__init__()" alt="" coords="48,1299,483,1331" />
427
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlModuleNode-class.html#_color" title="docwriter.dotgraph.DotGraphUmlModuleNode._color()" alt="" coords="47,1355,484,1387" />
428
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#specialize_valdoc_node" title="docwriter.dotgraph.specialize_valdoc_node()" alt="" coords="87,1411,444,1443" />
429
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="docwriter.dotgraph.uml_class_tree_graph()" alt="" coords="93,1467,437,1499" />
430
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="docwriter.html.HTMLWriter.__init__()" alt="" coords="107,1523,424,1555" />
431
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_attr_to_html" title="docwriter.html.HTMLWriter._attr_to_html()" alt="" coords="88,1579,443,1611" />
432
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="docwriter.html.HTMLWriter._url()" alt="" coords="123,1635,408,1667" />
433
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_val_is_public" title="docwriter.html.HTMLWriter._val_is_public()" alt="" coords="84,1691,447,1723" />
434
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#breadcrumbs" title="docwriter.html.HTMLWriter.breadcrumbs()" alt="" coords="91,1747,440,1779" />
435
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#function_signature" title="docwriter.html.HTMLWriter.function_signature()" alt="" coords="68,1803,463,1835" />
436
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#property_accessor_to_html" title="docwriter.html.HTMLWriter.property_accessor_to_html()" alt="" coords="37,1859,493,1891" />
437
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="docwriter.html.HTMLWriter.pysrc_url()" alt="" coords="103,1915,428,1947" />
438
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#variable_tooltip" title="docwriter.html.HTMLWriter.variable_tooltip()" alt="" coords="80,1971,451,2003" />
439
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_details_entry" title="docwriter.html.HTMLWriter.write_details_entry()" alt="" coords="67,2027,464,2059" />
440
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="docwriter.html.HTMLWriter.write_inheritance_list()" alt="" coords="57,2083,473,2115" />
441
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="docwriter.html.HTMLWriter.write_module_tree()" alt="" coords="68,2139,463,2171" />
442
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="docwriter.html.HTMLWriter.write_summary_group()" alt="" coords="53,2195,477,2227" />
443
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_line" title="docwriter.html.HTMLWriter.write_summary_line()" alt="" coords="61,2251,469,2283" />
444
<area shape="rect" href="epydoc.docwriter.html._HTMLDocstringLinker-class.html#translate_identifier_xref" title="docwriter.html._HTMLDocstringLinker.translate_identifier_xref()" alt="" coords="7,2307,524,2339" />
446
<img src="call_graph_for___cmp__.gif" alt='' usemap="#call_graph_for___cmp__" ismap="ismap" class="graph-without-title" />
448
<tr><th>Call Graph</th></tr>
455
<td width="15%" align="right" valign="top" class="summary">
456
<span class="summary-type"><code>bool</code></span>
457
</td><td class="summary">
458
<table width="100%" cellpadding="0" cellspacing="0" border="0">
460
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#is_detailed" class="summary-sig-name">is_detailed</a>(<span class="summary-sig-arg">self</span>)</span><br />
461
Does this object deserve a box with extra details?</td>
462
<td align="right" valign="top">
463
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.is_detailed">source code</a></span>
464
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed-summary-div');return false;">call graph</a></span>
468
<div style="display:none" id="call_graph_for_is_detailed-summary-div"><center>
469
<table border="0" cellpadding="0" cellspacing="0">
470
<tr><td><center> <map id="call_graph_for_is_detailed" name="call_graph_for_is_detailed">
471
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,62,385,94" />
472
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" title="PropertyDoc.is_detailed()" alt="" coords="7,6,220,38" />
473
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" title="RoutineDoc.is_detailed()" alt="" coords="9,62,217,94" />
474
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,118,221,150" />
476
<img src="call_graph_for_is_detailed.gif" alt='' usemap="#call_graph_for_is_detailed" ismap="ismap" class="graph-without-title" />
478
<tr><th>Call Graph</th></tr>
485
<td width="15%" align="right" valign="top" class="summary">
486
<span class="summary-type"> </span>
487
</td><td class="summary">
488
<table width="100%" cellpadding="0" cellspacing="0" border="0">
490
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" class="summary-sig-name">merge_and_overwrite</a>(<span class="summary-sig-arg">self</span>,
491
<span class="summary-sig-arg">other</span>,
492
<span class="summary-sig-arg">ignore_hash_conflict</span>=<span class="summary-sig-default">False</span>)</span><br />
493
Combine <code>self</code> and <code>other</code> into a <a
494
name="index-merged_object"></a><i class="indexterm">merged
495
object</i>, such that any changes made to one will affect the other.</td>
496
<td align="right" valign="top">
497
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.merge_and_overwrite">source code</a></span>
498
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_merge_and_overw-summary-div');return false;">call graph</a></span>
502
<div style="display:none" id="call_graph_for_merge_and_overw-summary-div"><center>
503
<table border="0" cellpadding="0" cellspacing="0">
504
<tr><td><center> <map id="call_graph_for_merge_and_overw" name="call_graph_for_merge_and_overw">
505
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="__cmp__()" alt="" coords="508,6,612,38" />
506
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="merge_and_overwrite()" alt="" coords="262,6,459,38" />
507
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="docbuilder.merge_docs()" alt="" coords="6,6,214,38" />
509
<img src="call_graph_for_merge_and_overw.gif" alt='' usemap="#call_graph_for_merge_and_overw" ismap="ismap" class="graph-without-title" />
511
<tr><th>Call Graph</th></tr>
518
<td width="15%" align="right" valign="top" class="summary">
519
<span class="summary-type"> </span>
520
</td><td class="summary">
521
<table width="100%" cellpadding="0" cellspacing="0" border="0">
523
<td><span class="summary-sig"><a href="epydoc.apidoc.APIDoc-class.html#apidoc_links" class="summary-sig-name">apidoc_links</a>(<span class="summary-sig-arg">self</span>,
524
<span class="summary-sig-arg">**filters</span>)</span><br />
525
Return a list of all <code>APIDoc</code>s that are directly linked
526
from this <code>APIDoc</code> (i.e., are contained or pointed to by
527
one or more of this <code>APIDoc</code>'s attributes.)</td>
528
<td align="right" valign="top">
529
<span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.apidoc_links">source code</a></span>
538
<td colspan="2" class="summary">
539
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
540
<code>__delattr__</code>,
541
<code>__getattribute__</code>,
542
<code>__new__</code>,
543
<code>__reduce__</code>,
544
<code>__reduce_ex__</code>
549
<!-- ==================== CLASS VARIABLES ==================== -->
550
<a name="section-ClassVariables"></a>
551
<table class="summary" border="1" cellpadding="3"
552
cellspacing="0" width="100%" bgcolor="white">
553
<tr bgcolor="#70b0f0" class="table-header">
554
<td colspan="2" class="table-header">
555
<table border="0" cellpadding="0" cellspacing="0" width="100%">
557
<td align="left"><span class="table-header">Class Variables</span></td>
558
<td align="right" valign="top"
559
><span class="options">[<a href="#section-ClassVariables"
560
class="privatelink" onclick="toggle_private();"
561
>hide private</a>]</span></td>
567
<td width="15%" align="right" valign="top" class="summary">
568
<span class="summary-type"> </span>
569
</td><td class="summary">
570
<a name="__has_been_hashed"></a><span class="summary-name">__has_been_hashed</span> = <code title="False">False</code><br />
571
True iff <a href="epydoc.apidoc.APIDoc-class.html#__hash__"
572
class="link">self.__hash__()</a> has ever been called.
576
<td width="15%" align="right" valign="top" class="summary">
577
<span class="summary-type"> </span>
578
</td><td class="summary">
579
<a href="epydoc.apidoc.APIDoc-class.html#__mergeset" class="summary-name" onclick="show_private();">__mergeset</a> = <code title="None">None</code><br />
580
The set of all <code>APIDoc</code> objects that have been merged with
581
this <code>APIDoc</code> (using <a
582
href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite"
583
class="link">merge_and_overwrite()</a>).
587
<!-- ==================== INSTANCE VARIABLES ==================== -->
588
<a name="section-InstanceVariables"></a>
589
<table class="summary" border="1" cellpadding="3"
590
cellspacing="0" width="100%" bgcolor="white">
591
<tr bgcolor="#70b0f0" class="table-header">
592
<td colspan="2" class="table-header">
593
<table border="0" cellpadding="0" cellspacing="0" width="100%">
595
<td align="left"><span class="table-header">Instance Variables</span></td>
596
<td align="right" valign="top"
597
><span class="options">[<a href="#section-InstanceVariables"
598
class="privatelink" onclick="toggle_private();"
599
>hide private</a>]</span></td>
604
<tr bgcolor="#e8f0f8" >
605
<th colspan="2" class="group-header"
606
> Docstrings</th></tr>
608
<td width="15%" align="right" valign="top" class="summary">
609
<span class="summary-type"><code>string</code> or <code>None</code></span>
610
</td><td class="summary">
611
<a name="docstring"></a><span class="summary-name">docstring</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
612
The documented item's docstring.
616
<td width="15%" align="right" valign="top" class="summary">
617
<span class="summary-type"><code>int</code></span>
618
</td><td class="summary">
619
<a name="docstring_lineno"></a><span class="summary-name">docstring_lineno</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
620
The line number on which the documented item's docstring begins.
623
<tr bgcolor="#e8f0f8" >
624
<th colspan="2" class="group-header"
625
> Information Extracted from Docstrings</th></tr>
627
<td width="15%" align="right" valign="top" class="summary">
628
<span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html"
629
class="link">ParsedDocstring</a></span>
630
</td><td class="summary">
631
<a name="descr"></a><span class="summary-name">descr</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
632
A description of the documented item, extracted from its docstring.
636
<td width="15%" align="right" valign="top" class="summary">
637
<span class="summary-type"><a href="epydoc.markup.ParsedDocstring-class.html"
638
class="link">ParsedDocstring</a></span>
639
</td><td class="summary">
640
<a name="summary"></a><span class="summary-name">summary</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
641
A summary description of the documented item, extracted from its
646
<td width="15%" align="right" valign="top" class="summary">
647
<span class="summary-type"><code>bool</code></span>
648
</td><td class="summary">
649
<a name="other_docs"></a><span class="summary-name">other_docs</span> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
650
A flag indicating if the entire <a
651
href="epydoc.apidoc.APIDoc-class.html#docstring"
652
class="link">docstring</a> body (except tags if any) is entirely
653
included in the <a href="epydoc.apidoc.APIDoc-class.html#summary"
654
class="link">summary</a>.
658
<td width="15%" align="right" valign="top" class="summary">
659
<span class="summary-type"><code>(str, str, <a href="epydoc.markup.ParsedDocstring-class.html"
660
class="link">ParsedDocstring</a>)</code></span>
661
</td><td class="summary">
662
<a href="epydoc.apidoc.APIDoc-class.html#metadata" class="summary-name">metadata</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
663
Metadata about the documented item, extracted from fields in its
668
<td width="15%" align="right" valign="top" class="summary">
669
<span class="summary-type"><a href="epydoc.docstringparser.DocstringField-class.html"
670
class="link">DocstringField</a></span>
671
</td><td class="summary">
672
<a href="epydoc.apidoc.APIDoc-class.html#extra_docstring_fields" class="summary-name">extra_docstring_fields</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
673
A list of new docstring fields tags that are defined by the
674
documented item's docstring.
677
<tr bgcolor="#e8f0f8" >
678
<th colspan="2" class="group-header"
679
> Source Information</th></tr>
681
<td width="15%" align="right" valign="top" class="summary">
682
<span class="summary-type"><code>str</code></span>
683
</td><td class="summary">
684
<a href="epydoc.apidoc.APIDoc-class.html#docs_extracted_by" class="summary-name">docs_extracted_by</a> = <code title="_Sentinel('UNKNOWN')">_Sentinel('UNKNOWN')</code><br />
685
Information about where the information contained by this
686
<code>APIDoc</code> came from.
690
<!-- ==================== PROPERTIES ==================== -->
691
<a name="section-Properties"></a>
692
<table class="summary" border="1" cellpadding="3"
693
cellspacing="0" width="100%" bgcolor="white">
694
<tr bgcolor="#70b0f0" class="table-header">
695
<td colspan="2" class="table-header">
696
<table border="0" cellpadding="0" cellspacing="0" width="100%">
698
<td align="left"><span class="table-header">Properties</span></td>
699
<td align="right" valign="top"
700
><span class="options">[<a href="#section-Properties"
701
class="privatelink" onclick="toggle_private();"
702
>hide private</a>]</span></td>
708
<td colspan="2" class="summary">
709
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
710
<code>__class__</code>
715
<!-- ==================== METHOD DETAILS ==================== -->
716
<a name="section-MethodDetails"></a>
717
<table class="details" border="1" cellpadding="3"
718
cellspacing="0" width="100%" bgcolor="white">
719
<tr bgcolor="#70b0f0" class="table-header">
720
<td colspan="2" class="table-header">
721
<table border="0" cellpadding="0" cellspacing="0" width="100%">
723
<td align="left"><span class="table-header">Method Details</span></td>
724
<td align="right" valign="top"
725
><span class="options">[<a href="#section-MethodDetails"
726
class="privatelink" onclick="toggle_private();"
727
>hide private</a>]</span></td>
733
<a name="__init__"></a>
735
<table class="details" border="1" cellpadding="3"
736
cellspacing="0" width="100%" bgcolor="white">
738
<table width="100%" cellpadding="0" cellspacing="0" border="0">
739
<tr valign="top"><td>
740
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
741
<span class="sig-arg">**kwargs</span>)</span>
742
<br /><em class="fname">(Constructor)</em>
744
</td><td align="right" valign="top"
745
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__init__">source code</a></span>
746
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init__-div');return false;">call graph</a></span> </td>
748
<div style="display:none" id="call_graph_for___init__-div"><center>
749
<table border="0" cellpadding="0" cellspacing="0">
750
<tr><td><center> <map id="call_graph_for___init__" name="call_graph_for___init__">
751
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="__init__()" alt="" coords="396,258,492,290" />
752
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="specialize_to()" alt="" coords="111,6,242,38" />
753
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="NamespaceDoc.__init__()" alt="" coords="67,62,286,94" />
754
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#__init__" title="VariableDoc.__init__()" alt="" coords="78,118,275,150" />
755
<area shape="rect" href="epydoc.docintrospecter-module.html#_get_valuedoc" title="docintrospecter._get_valuedoc()" alt="" coords="46,174,307,206" />
756
<area shape="rect" href="epydoc.docparser-module.html#apply_decorator" title="docparser.apply_decorator()" alt="" coords="60,230,292,262" />
757
<area shape="rect" href="epydoc.docparser-module.html#init_arglist" title="docparser.init_arglist()" alt="" coords="80,286,272,318" />
758
<area shape="rect" href="epydoc.docparser-module.html#lookup_value" title="docparser.lookup_value()" alt="" coords="71,342,282,374" />
759
<area shape="rect" href="epydoc.docparser-module.html#process_funcdef" title="docparser.process_funcdef()" alt="" coords="60,398,292,430" />
760
<area shape="rect" href="epydoc.docparser-module.html#rhs_to_valuedoc" title="docparser.rhs_to_valuedoc()" alt="" coords="59,454,294,486" />
761
<area shape="rect" href="epydoc.docstringparser-module.html#parse_function_signature" title="docstringparser.parse_function_signature()" alt="" coords="6,510,347,542" />
763
<img src="call_graph_for___init__.gif" alt='' usemap="#call_graph_for___init__" ismap="ismap" class="graph-without-title" />
765
<tr><th>Call Graph</th></tr>
769
<p>Construct a new <code>APIDoc</code> object. Keyword arguments may be
770
used to initialize the new <code>APIDoc</code>'s attributes.</p>
773
<dd><ul class="nomargin-top">
774
<li><code><strong class='fraise'>TypeError</strong></code> - If a keyword argument is specified that does not correspond to a
775
valid attribute for this (sub)class of <code>APIDoc</code>.</li>
783
<a name="_debug_setattr"></a>
784
<div class="private">
785
<table class="details" border="1" cellpadding="3"
786
cellspacing="0" width="100%" bgcolor="white">
788
<table width="100%" cellpadding="0" cellspacing="0" border="0">
789
<tr valign="top"><td>
790
<h3 class="epydoc"><span class="sig"><span class="sig-name">_debug_setattr</span>(<span class="sig-arg">self</span>,
791
<span class="sig-arg">attr</span>,
792
<span class="sig-arg">val</span>)</span>
794
</td><td align="right" valign="top"
795
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc._debug_setattr">source code</a></span>
799
<p>Modify an <code>APIDoc</code>'s attribute. This is used when <a
800
href="epydoc-module.html#DEBUG" class="link">epydoc.DEBUG</a> is true, to
801
make sure we don't accidentally set any inappropriate attributes on
802
<code>APIDoc</code> objects.</p>
805
<dd><ul class="nomargin-top">
806
<li><code><strong class='fraise'>AttributeError</strong></code> - If <code>attr</code> is not a valid attribute for this (sub)class
807
of <code>APIDoc</code>. (<code>attr</code> is considered a valid
808
attribute iff <code>self.__class__</code> defines an attribute with
814
<a name="__setattr__"></a>
816
<table class="details" border="1" cellpadding="3"
817
cellspacing="0" width="100%" bgcolor="white">
819
<table width="100%" cellpadding="0" cellspacing="0" border="0">
820
<tr valign="top"><td>
821
<h3 class="epydoc"><span class="sig"><span class="sig-name">__setattr__</span>(<span class="sig-arg">self</span>,
822
<span class="sig-arg">attr</span>,
823
<span class="sig-arg">val</span>)</span>
825
</td><td align="right" valign="top"
826
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc._debug_setattr">source code</a></span>
830
<p>Modify an <code>APIDoc</code>'s attribute. This is used when <a
831
href="epydoc-module.html#DEBUG" class="link">epydoc.DEBUG</a> is true, to
832
make sure we don't accidentally set any inappropriate attributes on
833
<code>APIDoc</code> objects.</p>
836
<dd><ul class="nomargin-top">
837
<li><code><strong class='fraise'>AttributeError</strong></code> - If <code>attr</code> is not a valid attribute for this (sub)class
838
of <code>APIDoc</code>. (<code>attr</code> is considered a valid
839
attribute iff <code>self.__class__</code> defines an attribute with
848
<a name="__repr__"></a>
850
<table class="details" border="1" cellpadding="3"
851
cellspacing="0" width="100%" bgcolor="white">
853
<table width="100%" cellpadding="0" cellspacing="0" border="0">
854
<tr valign="top"><td>
855
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
856
<br /><em class="fname">(Representation operator)</em>
858
</td><td align="right" valign="top"
859
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__repr__">source code</a></span>
863
<pre class="literalblock">
870
<dd><em class="note">(inherited documentation)</em></dd>
875
<a name="__str__"></a>
877
<table class="details" border="1" cellpadding="3"
878
cellspacing="0" width="100%" bgcolor="white">
880
<table width="100%" cellpadding="0" cellspacing="0" border="0">
881
<tr valign="top"><td>
882
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>,
883
<span class="sig-arg">doublespace</span>=<span class="sig-default">0</span>,
884
<span class="sig-arg">depth</span>=<span class="sig-default">5</span>,
885
<span class="sig-arg">exclude</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>,
886
<span class="sig-arg">include</span>=<span class="sig-default"><code class="variable-group">(</code><code class="variable-group">)</code></span>)</span>
887
<br /><em class="fname">(Informal representation operator)</em>
889
</td><td align="right" valign="top"
890
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.pp">source code</a></span>
894
<p>Return a pretty-printed string representation for the information
895
contained in this <code>APIDoc</code>.</p>
903
<a name="specialize_to"></a>
905
<table class="details" border="1" cellpadding="3"
906
cellspacing="0" width="100%" bgcolor="white">
908
<table width="100%" cellpadding="0" cellspacing="0" border="0">
909
<tr valign="top"><td>
910
<h3 class="epydoc"><span class="sig"><span class="sig-name">specialize_to</span>(<span class="sig-arg">self</span>,
911
<span class="sig-arg">cls</span>)</span>
913
</td><td align="right" valign="top"
914
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.specialize_to">source code</a></span>
915
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_specialize_to-div');return false;">call graph</a></span> </td>
917
<div style="display:none" id="call_graph_for_specialize_to-div"><center>
918
<table border="0" cellpadding="0" cellspacing="0">
919
<tr><td><center> <map id="call_graph_for_specialize_to" name="call_graph_for_specialize_to">
920
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__init__" title="__init__()" alt="" coords="596,118,692,150" />
921
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#specialize_to" title="specialize_to()" alt="" coords="353,146,484,178" />
922
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#__init__" title="NamespaceDoc.__init__()" alt="" coords="535,174,753,206" />
923
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="docbuilder.merge_docs()" alt="" coords="51,6,259,38" />
924
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_class" title="docintrospecter.introspect_class()" alt="" coords="19,62,291,94" />
925
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_module" title="docintrospecter.introspect_module()" alt="" coords="9,118,300,150" />
926
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_other" title="docintrospecter.introspect_other()" alt="" coords="17,174,292,206" />
927
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_property" title="docintrospecter.introspect_property()" alt="" coords="5,230,304,262" />
928
<area shape="rect" href="epydoc.docintrospecter-module.html#introspect_routine" title="docintrospecter.introspect_routine()" alt="" coords="11,286,299,318" />
930
<img src="call_graph_for_specialize_to.gif" alt='' usemap="#call_graph_for_specialize_to" ismap="ismap" class="graph-without-title" />
932
<tr><th>Call Graph</th></tr>
936
<p>Change <code>self</code>'s class to <code>cls</code>.
937
<code>cls</code> must be a subclass of <code>self</code>'s current class.
938
For example, if a generic <code>ValueDoc</code> was created for a value,
939
and it is determined that the value is a routine, you can update its
941
<pre class="py-doctest">
942
<span class="py-prompt">>>> </span>valdoc.specialize_to(RoutineDoc)</pre>
947
<a name="__hash__"></a>
949
<table class="details" border="1" cellpadding="3"
950
cellspacing="0" width="100%" bgcolor="white">
952
<table width="100%" cellpadding="0" cellspacing="0" border="0">
953
<tr valign="top"><td>
954
<h3 class="epydoc"><span class="sig"><span class="sig-name">__hash__</span>(<span class="sig-arg">self</span>)</span>
955
<br /><em class="fname">(Hashing function)</em>
957
</td><td align="right" valign="top"
958
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.__hash__">source code</a></span>
959
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___hash__-div');return false;">call graph</a></span> </td>
961
<div style="display:none" id="call_graph_for___hash__-div"><center>
962
<table border="0" cellpadding="0" cellspacing="0">
963
<tr><td><center> <map id="call_graph_for___hash__" name="call_graph_for___hash__">
964
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__hash__" title="__hash__()" alt="" coords="579,511,686,543" />
965
<area shape="rect" href="epydoc.apidoc.ClassDoc-class.html#_dfs_bases" title="ClassDoc._dfs_bases()" alt="" coords="172,7,364,39" />
966
<area shape="rect" href="epydoc.apidoc.DocIndex-class.html#container" title="DocIndex.container()" alt="" coords="178,63,359,95" />
967
<area shape="rect" href="epydoc.apidoc.NamespaceDoc-class.html#_init_grouping" title="NamespaceDoc._init_grouping()" alt="" coords="135,119,402,151" />
968
<area shape="rect" href="epydoc.apidoc-module.html#reachable_valdocs" title="reachable_valdocs()" alt="" coords="182,175,355,207" />
969
<area shape="rect" href="epydoc.docbuilder-module.html#assign_canonical_names" title="docbuilder.assign_canonical_names()" alt="" coords="118,231,419,263" />
970
<area shape="rect" href="epydoc.docbuilder-module.html#build_doc_index" title="docbuilder.build_doc_index()" alt="" coords="147,287,390,319" />
971
<area shape="rect" href="epydoc.docstringparser-module.html#parse_docstring" title="docstringparser.parse_docstring()" alt="" coords="132,343,404,375" />
972
<area shape="rect" href="epydoc.docwriter.dotgraph.DotGraphUmlClassNode-class.html#_add_attribute_edge" title="docwriter.dotgraph.DotGraphUmlClassNode._add_attribute_edge()" alt="" coords="6,399,531,431" />
973
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#add_valdoc_nodes" title="docwriter.dotgraph.add_valdoc_nodes()" alt="" coords="108,455,428,487" />
974
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#class_tree_graph" title="docwriter.dotgraph.class_tree_graph()" alt="" coords="115,511,422,543" />
975
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#import_graph" title="docwriter.dotgraph.import_graph()" alt="" coords="128,567,408,599" />
976
<area shape="rect" href="epydoc.docwriter.dotgraph-module.html#uml_class_tree_graph" title="docwriter.dotgraph.uml_class_tree_graph()" alt="" coords="96,623,440,655" />
977
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#__init__" title="docwriter.html.HTMLWriter.__init__()" alt="" coords="110,679,427,711" />
978
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#_url" title="docwriter.html.HTMLWriter._url()" alt="" coords="126,735,411,767" />
979
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#pysrc_url" title="docwriter.html.HTMLWriter.pysrc_url()" alt="" coords="106,791,431,823" />
980
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_class_tree" title="docwriter.html.HTMLWriter.write_class_tree()" alt="" coords="80,847,456,879" />
981
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_inheritance_list" title="docwriter.html.HTMLWriter.write_inheritance_list()" alt="" coords="60,903,476,935" />
982
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_module_tree" title="docwriter.html.HTMLWriter.write_module_tree()" alt="" coords="71,959,466,991" />
983
<area shape="rect" href="epydoc.docwriter.html.HTMLWriter-class.html#write_summary_group" title="docwriter.html.HTMLWriter.write_summary_group()" alt="" coords="56,1015,480,1047" />
985
<img src="call_graph_for___hash__.gif" alt='' usemap="#call_graph_for___hash__" ismap="ismap" class="graph-without-title" />
987
<tr><th>Call Graph</th></tr>
991
<pre class="literalblock">
998
<dd><em class="note">(inherited documentation)</em></dd>
1003
<a name="is_detailed"></a>
1005
<table class="details" border="1" cellpadding="3"
1006
cellspacing="0" width="100%" bgcolor="white">
1008
<table width="100%" cellpadding="0" cellspacing="0" border="0">
1009
<tr valign="top"><td>
1010
<h3 class="epydoc"><span class="sig"><span class="sig-name">is_detailed</span>(<span class="sig-arg">self</span>)</span>
1012
</td><td align="right" valign="top"
1013
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.is_detailed">source code</a></span>
1014
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_is_detailed-div');return false;">call graph</a></span> </td>
1016
<div style="display:none" id="call_graph_for_is_detailed-div"><center>
1017
<table border="0" cellpadding="0" cellspacing="0">
1018
<tr><td><center> <map id="call_graph_for_is_detailed" name="call_graph_for_is_detailed">
1019
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#is_detailed" title="is_detailed()" alt="" coords="271,62,385,94" />
1020
<area shape="rect" href="epydoc.apidoc.PropertyDoc-class.html#is_detailed" title="PropertyDoc.is_detailed()" alt="" coords="7,6,220,38" />
1021
<area shape="rect" href="epydoc.apidoc.RoutineDoc-class.html#is_detailed" title="RoutineDoc.is_detailed()" alt="" coords="9,62,217,94" />
1022
<area shape="rect" href="epydoc.apidoc.VariableDoc-class.html#is_detailed" title="VariableDoc.is_detailed()" alt="" coords="5,118,221,150" />
1024
<img src="call_graph_for_is_detailed.gif" alt='' usemap="#call_graph_for_is_detailed" ismap="ismap" class="graph-without-title" />
1026
<tr><th>Call Graph</th></tr>
1030
<p>Does this object deserve a box with extra details?</p>
1032
<dt>Returns: <code>bool</code></dt>
1033
<dd>True if the object needs extra details, else False.</dd>
1037
<a name="merge_and_overwrite"></a>
1039
<table class="details" border="1" cellpadding="3"
1040
cellspacing="0" width="100%" bgcolor="white">
1042
<table width="100%" cellpadding="0" cellspacing="0" border="0">
1043
<tr valign="top"><td>
1044
<h3 class="epydoc"><span class="sig"><span class="sig-name">merge_and_overwrite</span>(<span class="sig-arg">self</span>,
1045
<span class="sig-arg">other</span>,
1046
<span class="sig-arg">ignore_hash_conflict</span>=<span class="sig-default">False</span>)</span>
1048
</td><td align="right" valign="top"
1049
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.merge_and_overwrite">source code</a></span>
1050
<br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_merge_and_overw-div');return false;">call graph</a></span> </td>
1052
<div style="display:none" id="call_graph_for_merge_and_overw-div"><center>
1053
<table border="0" cellpadding="0" cellspacing="0">
1054
<tr><td><center> <map id="call_graph_for_merge_and_overw" name="call_graph_for_merge_and_overw">
1055
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#__cmp__" title="__cmp__()" alt="" coords="508,6,612,38" />
1056
<area shape="rect" href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite" title="merge_and_overwrite()" alt="" coords="262,6,459,38" />
1057
<area shape="rect" href="epydoc.docbuilder-module.html#merge_docs" title="docbuilder.merge_docs()" alt="" coords="6,6,214,38" />
1059
<img src="call_graph_for_merge_and_overw.gif" alt='' usemap="#call_graph_for_merge_and_overw" ismap="ismap" class="graph-without-title" />
1061
<tr><th>Call Graph</th></tr>
1065
<p>Combine <code>self</code> and <code>other</code> into a <a
1066
name="index-merged_object"></a><i class="indexterm">merged object</i>,
1067
such that any changes made to one will affect the other. Any attributes
1068
that <code>other</code> had before merging will be discarded. This is
1069
accomplished by copying <code>self.__dict__</code> over
1070
<code>other.__dict__</code> and <code>self.__class__</code> over
1071
<code>other.__class__</code>.</p>
1072
<p>Care must be taken with this method, since it modifies the hash value
1073
of <code>other</code>. To help avoid the problems that this can cause,
1074
<code>merge_and_overwrite</code> will raise an exception if
1075
<code>other</code> has ever been hashed, unless
1076
<code>ignore_hash_conflict</code> is True. Note that adding
1077
<code>other</code> to a dictionary, set, or similar data structure will
1078
implicitly cause it to be hashed. If you do set
1079
<code>ignore_hash_conflict</code> to True, then any existing data
1080
structures that rely on <code>other</code>'s hash staying constant may
1081
become corrupted.</p>
1084
<dd><code>self</code></dd>
1086
<dd><ul class="nomargin-top">
1087
<li><code><strong class='fraise'>ValueError</strong></code> - If <code>other</code> has ever been hashed.</li>
1092
<a name="apidoc_links"></a>
1094
<table class="details" border="1" cellpadding="3"
1095
cellspacing="0" width="100%" bgcolor="white">
1097
<table width="100%" cellpadding="0" cellspacing="0" border="0">
1098
<tr valign="top"><td>
1099
<h3 class="epydoc"><span class="sig"><span class="sig-name">apidoc_links</span>(<span class="sig-arg">self</span>,
1100
<span class="sig-arg">**filters</span>)</span>
1102
</td><td align="right" valign="top"
1103
><span class="codelink"><a href="epydoc.apidoc-pysrc.html#APIDoc.apidoc_links">source code</a></span>
1107
<p>Return a list of all <code>APIDoc</code>s that are directly linked
1108
from this <code>APIDoc</code> (i.e., are contained or pointed to by one
1109
or more of this <code>APIDoc</code>'s attributes.)</p>
1110
<p>Keyword argument <code>filters</code> can be used to selectively
1111
exclude certain categories of attribute value. For example, using
1112
<code>includes=False</code> will exclude variables that were imported
1113
from other modules; and <code>subclasses=False</code> will exclude
1114
subclasses. The filter categories currently supported by epydoc are:</p>
1117
<code>imports</code>: Imported variables.
1120
<code>packages</code>: Containing packages for modules.
1123
<code>submodules</code>: Contained submodules for packages.
1126
<code>bases</code>: Bases for classes.
1129
<code>subclasses</code>: Subclasses for classes.
1132
<code>variables</code>: All variables.
1135
<code>private</code>: Private variables.
1138
<code>overrides</code>: Points from class variables to the variables
1139
they override. This filter is False by default.
1147
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
1148
<a name="section-ClassVariableDetails"></a>
1149
<table class="details" border="1" cellpadding="3"
1150
cellspacing="0" width="100%" bgcolor="white">
1151
<tr bgcolor="#70b0f0" class="table-header">
1152
<td colspan="2" class="table-header">
1153
<table border="0" cellpadding="0" cellspacing="0" width="100%">
1155
<td align="left"><span class="table-header">Class Variable Details</span></td>
1156
<td align="right" valign="top"
1157
><span class="options">[<a href="#section-ClassVariableDetails"
1158
class="privatelink" onclick="toggle_private();"
1159
>hide private</a>]</span></td>
1165
<a name="__mergeset"></a>
1166
<div class="private">
1167
<table class="details" border="1" cellpadding="3"
1168
cellspacing="0" width="100%" bgcolor="white">
1170
<h3 class="epydoc">__mergeset</h3>
1171
<p>The set of all <code>APIDoc</code> objects that have been merged with
1172
this <code>APIDoc</code> (using <a
1173
href="epydoc.apidoc.APIDoc-class.html#merge_and_overwrite"
1174
class="link">merge_and_overwrite()</a>). Each <code>APIDoc</code> in
1175
this set shares a common instance dictionary (<code>__dict__</code>).</p>
1180
<dd><table><tr><td><pre class="variable">
1182
</pre></td></tr></table>
1188
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
1189
<a name="section-InstanceVariableDetails"></a>
1190
<table class="details" border="1" cellpadding="3"
1191
cellspacing="0" width="100%" bgcolor="white">
1192
<tr bgcolor="#70b0f0" class="table-header">
1193
<td colspan="2" class="table-header">
1194
<table border="0" cellpadding="0" cellspacing="0" width="100%">
1196
<td align="left"><span class="table-header">Instance Variable Details</span></td>
1197
<td align="right" valign="top"
1198
><span class="options">[<a href="#section-InstanceVariableDetails"
1199
class="privatelink" onclick="toggle_private();"
1200
>hide private</a>]</span></td>
1206
<a name="metadata"></a>
1208
<table class="details" border="1" cellpadding="3"
1209
cellspacing="0" width="100%" bgcolor="white">
1211
<h3 class="epydoc">metadata</h3>
1212
Metadata about the documented item, extracted from fields in its
1213
docstring. <i>Currently</i> this is encoded as a list of tuples
1214
<code>(field, arg, descr)</code>. But that may change.
1217
<dd><code>(str, str, <a href="epydoc.markup.ParsedDocstring-class.html"
1218
class="link">ParsedDocstring</a>)</code></dd>
1222
<dd><table><tr><td><pre class="variable">
1223
_Sentinel('UNKNOWN')
1224
</pre></td></tr></table>
1229
<a name="extra_docstring_fields"></a>
1231
<table class="details" border="1" cellpadding="3"
1232
cellspacing="0" width="100%" bgcolor="white">
1234
<h3 class="epydoc">extra_docstring_fields</h3>
1235
A list of new docstring fields tags that are defined by the documented
1236
item's docstring. These new field tags can be used by this item or by
1237
any item it contains.
1240
<dd><a href="epydoc.docstringparser.DocstringField-class.html"
1241
class="link">DocstringField</a></dd>
1245
<dd><table><tr><td><pre class="variable">
1246
_Sentinel('UNKNOWN')
1247
</pre></td></tr></table>
1252
<a name="docs_extracted_by"></a>
1254
<table class="details" border="1" cellpadding="3"
1255
cellspacing="0" width="100%" bgcolor="white">
1257
<h3 class="epydoc">docs_extracted_by</h3>
1258
Information about where the information contained by this
1259
<code>APIDoc</code> came from. Can be one of <code>'parser'</code>,
1260
<code>'introspector'</code>, or <code>'both'</code>.
1263
<dd><code>str</code></dd>
1267
<dd><table><tr><td><pre class="variable">
1268
_Sentinel('UNKNOWN')
1269
</pre></td></tr></table>
1275
<!-- ==================== NAVIGATION BAR ==================== -->
1276
<table class="navbar" border="0" width="100%" cellpadding="0"
1277
bgcolor="#a0c0ff" cellspacing="0">
1278
<tr valign="middle">
1280
<th> <a
1281
href="epydoc-module.html">Home</a> </th>
1284
<th> <a
1285
href="module-tree.html">Trees</a> </th>
1288
<th> <a
1289
href="identifier-index.html">Indices</a> </th>
1292
<th> <a
1293
href="help.html">Help</a> </th>
1295
<!-- Project homepage -->
1296
<th class="navbar" align="right" width="100%">
1297
<table border="0" cellpadding="0" cellspacing="0">
1298
<tr><th class="navbar" align="center"
1299
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
1303
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
1305
<td align="left" class="footer">
1306
<a href="epydoc-log.html">Generated by Epydoc
1307
3.0.1 on Wed Jan 30 14:06:57 2008</a>
1309
<td align="right" class="footer">
1310
<a target="mainFrame" href="http://epydoc.sourceforge.net"
1311
>http://epydoc.sourceforge.net</a>
1316
<script type="text/javascript">
1318
// Private objects are initially displayed (because if
1319
// javascript is turned off then we want them to be
1320
// visible); but by default, we want to hide them. So hide
1321
// them unless we have a cookie that says to show them.
added
removed
doc/api/epydoc.apidoc.APIDoc-class.html
