1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.objdoc.ClassDoc</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.objdoc-module.html">Module objdoc</a> ::
Class ClassDoc
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.objdoc.ClassDoc-class.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.objdoc.ClassDoc-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class ClassDoc</h2>
<pre class="base-tree">
<a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a> --+
|
<b>ClassDoc</b>
</pre><br />
<hr/>
The documentation for a class. This documentation consists of standard
pieces of documentation (as defined in <a
href="epydoc.objdoc.ObjDoc-class.html"
class="link"><code>ObjDoc</code></a>), and the following class-specific
pieces of documentation:
<ul>
<li>
<a name="index-bases"></a><i class="indexterm">bases</i>: A list
of the class's base classes.
</li>
<li>
<a name="index-subclasses"></a><i
class="indexterm">subclasses</i>: A list of the class's known
subclasses.
</li>
<li>
<a name="index-methods"></a><i class="indexterm">methods</i>: A
list of the methods defined by the class.
</li>
<li>
<a name="index-staticmethods"></a><i
class="indexterm">staticmethods</i>: A list of static methods defined
by the class.
</li>
<li>
<a name="index-classmethods"></a><i
class="indexterm">classmethods</i>: A list of class methods defined
by the class.
</li>
<li>
<a name="index-properties"></a><i
class="indexterm">properties</i>: A list of properties defined by the
class.
</li>
<li>
<a name="index-ivariables"></a><i
class="indexterm">ivariables</i>: A list of the instance variables
defined by the class.
</li>
<li>
<a name="index-cvariables"></a><i
class="indexterm">cvariables</i>: A list of the class variables
defined by the class.
</li>
<li>
<a name="index-module"></a><i class="indexterm">module</i>: The
module that defines the class.
</li>
</ul>
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>,
<span class=summary-sig-arg>verbosity</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td colspan="2">
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Accessors</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>boolean</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#is_exception" class="summary-sig-name"><code>is_exception</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return true if this <code>ClassDoc</code> documents an exception class.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#methods" class="summary-sig-name"><code>methods</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all (instance) methods defined by the class documented by
this <code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#classmethods" class="summary-sig-name"><code>classmethods</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all class methods defined by the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#staticmethods" class="summary-sig-name"><code>staticmethods</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all static methods defined by the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#properties" class="summary-sig-name"><code>properties</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all properties defined by the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#allmethods" class="summary-sig-name"><code>allmethods</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all instance, class, and static methods defined by the class
documented by this <code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#cvariables" class="summary-sig-name"><code>cvariables</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all class variables defined by the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#ivariables" class="summary-sig-name"><code>ivariables</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all instance variables defined by the class documented by
this <code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#bases" class="summary-sig-name"><code>bases</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all base classes for the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#subclasses" class="summary-sig-name"><code>subclasses</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of known subclasses for the class documented by this
<code>ClassDoc</code>, sorted by name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a> or
<code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#property_type" class="summary-sig-name"><code>property_type</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>uid</span>)</span></code>
<br />
Return the type for the given property, as specified by the docstring of the
class documented by this <code>ClassDoc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#base_order" class="summary-sig-name"><code>base_order</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a list of all base ancestors of the class documented by this
<code>ClassDoc</code>, listed in the order that they are searched by
<code>Python</code> for members.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="epydoc.objdoc.ObjDoc-class.html#by_group"><code>by_group</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#defines_groups"><code>defines_groups</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#descr"><code>descr</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#field_values"><code>field_values</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#fields"><code>fields</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#groups"><code>groups</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#has_docstring"><code>has_docstring</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#sortorder"><code>sortorder</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#summary"><code>summary</code></a>,
<a href="epydoc.objdoc.ObjDoc-class.html#uid"><code>uid</code></a>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inheritance</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#add_subclasses" class="summary-sig-name"><code>add_subclasses</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>classes</span>)</span></code>
<br />
Register subclasses for the class doumented by this
<code>ClassDoc</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>None</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.objdoc.ClassDoc-class.html#inherit" class="summary-sig-name"><code>inherit</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>base_docs</span>,
<span class=summary-sig-arg>inheritance_groups</span>,
<span class=summary-sig-arg>inherit_groups</span>)</span></code>
<br />
Add inherited variables and groups to this <code>ClassDoc</code>.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Docstring Parsing</th></tr>
<tr><td colspan="2">
<b>Inherited from <a href="epydoc.objdoc.ObjDoc-class.html"><code>ObjDoc</code></a>:</b>
<a href="epydoc.objdoc.ObjDoc-class.html#STANDARD_FIELDS"><code>STANDARD_FIELDS</code></a>
</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="is_exception"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">is_exception</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if this <code>ClassDoc</code> documents an exception
class.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="methods"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">methods</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all (instance) methods defined by the class
documented by this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="classmethods"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">classmethods</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all class methods defined by the class documented by
this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="staticmethods"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">staticmethods</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all static methods defined by the class documented
by this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="properties"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">properties</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all properties defined by the class documented by
this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="allmethods"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">allmethods</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all instance, class, and static methods defined by
the class documented by this <code>ClassDoc</code>, sorted by
name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
<dl><dt><b>See Also:</b></dt>
<dd>
<a href="epydoc.objdoc.ClassDoc-class.html#methods"
class="link"><code>methods</code></a>,
<a href="epydoc.objdoc.ClassDoc-class.html#staticmethods"
class="link"><code>staticmethods</code></a>,
<a href="epydoc.objdoc.ClassDoc-class.html#classmethods"
class="link"><code>classmethods</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="cvariables"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cvariables</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all class variables defined by the class documented
by this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="ivariables"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">ivariables</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all instance variables defined by the class
documented by this <code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.objdoc.Var-class.html"
class="link"><code>Var</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="bases"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">bases</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all base classes for the class documented by this
<code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="subclasses"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">subclasses</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of known subclasses for the class documented by this
<code>ClassDoc</code>, sorted by name.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.Link-class.html"
class="link"><code>Link</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="property_type"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">property_type</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>uid</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The type for the given property, as specified by the docstring
of the class documented by this <code>ClassDoc</code>. If the
docstring doesn't specify a type, then <code>None</code> is
returned. (But note that the property can also specify its type
in its own docstring).
<br /><i>
(type=<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>markup.ParsedDocstring</code></a> or
<code>None</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="base_order"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">base_order</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of all base ancestors of the class documented by this
<code>ClassDoc</code>, listed in the order that they are searched
by <code>Python</code> for members. The first element of this
list will always be the <code>UID</code> of the class documented
by this <code>ClassDoc</code>.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="add_subclasses"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add_subclasses</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>classes</span>)</span>
</h3>
Register subclasses for the class doumented by this
<code>ClassDoc</code>. This must be done externally, since we can't
determine a class's subclasses through introspection alone. This is
automatically called by <a href="epydoc.objdoc.DocMap-class.html#add"
class="link"><code>DocMap.add</code></a> when new classes are added to
a <code>DocMap</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>classes</b></code> -
A list of subclasses.
<br /><i>
(type=<code>list</code> of <a href="epydoc.uid.UID-class.html"
class="link"><code>UID</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="inherit"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">inherit</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>base_docs</span>,
<span class=sig-arg>inheritance_groups</span>,
<span class=sig-arg>inherit_groups</span>)</span>
</h3>
Add inherited variables and groups to this <code>ClassDoc</code>. To
search for inherited variables and groups, <code>inherit</code> uses a
list of the documentation objects for every base ancestor of the class
documented by this <code>ClassDoc</code>. Typical usage is:
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">>>> </span>doc.inherit([docmap[b] <span class="py-keyword">for</span> b <span class="py-keyword">in</span> doc.base_order()])</span></pre>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>base_docs</b></code> -
A list of the <code>ClassDoc</code>s for every base ancestor
of the class documented by this <code>ClassDoc</code>. These
should be the <code>ClassDoc</code>s for the classes returned by
<a href="epydoc.objdoc.ClassDoc-class.html#base_order"
class="link"><code>base_order</code></a>, in the order that they
are returned by <a
href="epydoc.objdoc.ClassDoc-class.html#base_order"
class="link"><code>base_order</code></a>.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.objdoc.ClassDoc-class.html"
class="link"><code>ClassDoc</code></a>)</i>
<dd><code><b>inheritance_groups</b></code> -
If true, then create a group for each base ancestor,
containing the members that are inherited from that base. These
groups have names of the form <code>'Inherited from <i
class="math">base</i>'</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>inherit_groups</b></code> -
If true, then inherit groups from the base ancestors.
<br /><i>
(type=<code>boolean</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
