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
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>epydoc.checker.DocChecker</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.checker-module.html">Module checker</a> ::
Class DocChecker
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="epydoc.checker.DocChecker-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DocChecker</h1><p class="nomargin-top"><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker">source code</a></span></p>
<p>Documentation completeness checker. <code>DocChecker</code> can be
used to check that specified classes of objects are documented. To check
the documentation for a group of objects, you should create a
<code>DocChecker</code> from a <a
href="epydoc.apidoc.DocIndex-class.html" class="link">DocIndex</a> that
documents those objects; and then use the <a
href="epydoc.checker.DocChecker-class.html#check" class="link">check</a>
method to run specified checks on the objects' documentation.</p>
<p>What checks are run, and what objects they are run on, are specified
by the constants defined by <code>DocChecker</code>. These constants are
divided into three groups.</p>
<ul>
<li>
Type specifiers indicate what type of objects should be checked: <a
href="epydoc.checker.DocChecker-class.html#MODULE"
class="link">MODULE</a>; <a
href="epydoc.checker.DocChecker-class.html#CLASS"
class="link">CLASS</a>; <a
href="epydoc.checker.DocChecker-class.html#FUNC"
class="link">FUNC</a>; <a
href="epydoc.checker.DocChecker-class.html#VAR" class="link">VAR</a>;
<a href="epydoc.checker.DocChecker-class.html#IVAR"
class="link">IVAR</a>; <a
href="epydoc.checker.DocChecker-class.html#CVAR"
class="link">CVAR</a>; <a
href="epydoc.checker.DocChecker-class.html#PARAM"
class="link">PARAM</a>; and <a
href="epydoc.checker.DocChecker-class.html#RETURN"
class="link">RETURN</a>.
</li>
<li>
Public/private specifiers indicate whether public or private objects
should be checked: <a
href="epydoc.checker.DocChecker-class.html#PRIVATE"
class="link">PRIVATE</a>.
</li>
<li>
Check specifiers indicate what checks should be run on the objects:
<a href="epydoc.checker.DocChecker-class.html#TYPE"
class="link">TYPE</a>; <a
href="epydoc.checker.DocChecker-class.html#DESCR"
class="link">DESCR</a>; <a
href="epydoc.checker.DocChecker-class.html#AUTHOR"
class="link">AUTHOR</a>; and <a
href="epydoc.checker.DocChecker-class.html#VERSION"
class="link">VERSION</a>.
</li>
</ul>
<p>The <a href="epydoc.checker.DocChecker-class.html#check"
class="link">check</a> method is used to perform a check on the
documentation. Its parameter is formed by or-ing together at least one
value from each specifier group:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>checker.check(DocChecker.MODULE | DocChecker.DESCR)</pre>
<p>To specify multiple values from a single group, simply or their values
together:</p>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>checker.check(DocChecker.MODULE | DocChecker.CLASS |
<span class="py-more">... </span> DocChecker.FUNC )</pre>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">docindex</span>)</span><br />
Create a new <code>DocChecker</code> that can be used to run checks
on the documentation of the objects documented by
<code>docindex</code></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>boolean</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">*check_sets</span>)</span><br />
Run the specified checks on the documentation of the objects
contained by this <code>DocChecker</code>'s <code>DocIndex</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker.check">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_check"></a><span class="summary-sig-name">_check</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">checks</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_name"></a><span class="summary-sig-name">_name</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._name">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#_check_basic" class="summary-sig-name" onclick="show_private();">_check_basic</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Check the description, author, version, and see-also fields of
<code>doc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_basic">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#_check_module" class="summary-sig-name" onclick="show_private();">_check_module</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Run checks on the module whose APIDoc is <code>doc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_module">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#_check_class" class="summary-sig-name" onclick="show_private();">_check_class</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Run checks on the class whose APIDoc is <code>doc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_class">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_check_property"></a><span class="summary-sig-name">_check_property</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_property">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#_check_var" class="summary-sig-name" onclick="show_private();">_check_var</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Run checks on the variable whose documentation is <code>var</code>
and whose name is <code>name</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_var">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>None</code></span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="epydoc.checker.DocChecker-class.html#_check_func" class="summary-sig-name" onclick="show_private();">_check_func</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">doc</span>)</span><br />
Run checks on the function whose APIDoc is <code>doc</code>.</td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_func">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="warning"></a><span class="summary-sig-name">warning</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">msg</span>,
<span class="summary-sig-arg">doc</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker.warning">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="PROPERTY"></a><span class="summary-name">PROPERTY</span> = <code title="256">256</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="ALL"></a><span class="summary-name">ALL</span> = <code title="24831">24831</code>
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Types</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="MODULE"></a><span class="summary-name">MODULE</span> = <code title="1">1</code><br />
Type specifier that indicates that the documentation of modules
should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="CLASS"></a><span class="summary-name">CLASS</span> = <code title="2">2</code><br />
Type specifier that indicates that the documentation of classes
should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="FUNC"></a><span class="summary-name">FUNC</span> = <code title="4">4</code><br />
Type specifier that indicates that the documentation of functions
should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="VAR"></a><span class="summary-name">VAR</span> = <code title="8">8</code><br />
Type specifier that indicates that the documentation of module
variables should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="PARAM"></a><span class="summary-name">PARAM</span> = <code title="64">64</code><br />
Type specifier that indicates that the documentation of function and
method parameters should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="RETURN"></a><span class="summary-name">RETURN</span> = <code title="128">128</code><br />
Type specifier that indicates that the documentation of return values
should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="ALL_T"></a><span class="summary-name">ALL_T</span> = <code title="511">511</code><br />
Type specifier that indicates that the documentation of all objects
should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="CVAR"></a><span class="summary-name">CVAR</span><br />
Type specifier that indicates that the documentation of class
variables should be checked.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="IVAR"></a><span class="summary-name">IVAR</span><br />
Type specifier that indicates that the documentation of instance
variables should be checked.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Checks</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="TYPE"></a><span class="summary-name">TYPE</span> = <code title="256">256</code><br />
Check specifier that indicates that every variable and parameter
should have a <code>@type</code> field.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="AUTHOR"></a><span class="summary-name">AUTHOR</span> = <code title="1024">1024</code><br />
Check specifier that indicates that every object should have an
<code>author</code> field.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="VERSION"></a><span class="summary-name">VERSION</span> = <code title="2048">2048</code><br />
Check specifier that indicates that every object should have a
<code>version</code> field.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="DESCR"></a><span class="summary-name">DESCR</span> = <code title="4096">4096</code><br />
Check specifier that indicates that every object should have a
description.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="ALL_C"></a><span class="summary-name">ALL_C</span> = <code title="7936">7936</code><br />
Check specifier that indicates that all checks should be run.
</td>
</tr>
<tr bgcolor="#e8f0f8" >
<th colspan="2" class="group-header"
> Publicity</th></tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"><code>int</code></span>
</td><td class="summary">
<a name="PRIVATE"></a><span class="summary-name">PRIVATE</span> = <code title="16384">16384</code><br />
Specifier that indicates that private objects should be checked.
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">docindex</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker.__init__">source code</a></span>
</td>
</tr></table>
<p>Create a new <code>DocChecker</code> that can be used to run checks on
the documentation of the objects documented by <code>docindex</code></p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>docindex</code></strong> (<a href="epydoc.apidoc.DocIndex-class.html"
class="link">Docindex</a>) - A documentation map containing the documentation for the objects
to be checked.</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="check"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*check_sets</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker.check">source code</a></span>
</td>
</tr></table>
<p>Run the specified checks on the documentation of the objects contained
by this <code>DocChecker</code>'s <code>DocIndex</code>. Any errors
found are printed to standard out.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>check_sets</code></strong> (<code>int</code>) - The checks that should be run on the documentation. This value
is constructed by or-ing together the specifiers that indicate
which objects should be checked, and which checks should be run.
See the <a href="epydoc.checker-module.html" class="link">module
description</a> for more information. If no checks are specified,
then a default set of checks will be run.</li>
</ul></dd>
<dt>Returns: <code>boolean</code></dt>
<dd>True if no problems were found.</dd>
</dl>
</td></tr></table>
</div>
<a name="_check_basic"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_check_basic</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_basic">source code</a></span>
</td>
</tr></table>
<p>Check the description, author, version, and see-also fields of
<code>doc</code>. This is used as a helper function by <a
href="epydoc.checker.DocChecker-class.html#_check_module" class="link"
onclick="show_private();">_check_module</a>, <a
href="epydoc.checker.DocChecker-class.html#_check_class" class="link"
onclick="show_private();">_check_class</a>, and <a
href="epydoc.checker.DocChecker-class.html#_check_func" class="link"
onclick="show_private();">_check_func</a>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The documentation that should be checked.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<a name="_check_module"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_check_module</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_module">source code</a></span>
</td>
</tr></table>
<p>Run checks on the module whose APIDoc is <code>doc</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The APIDoc of the module to check.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<a name="_check_class"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_check_class</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_class">source code</a></span>
</td>
</tr></table>
<p>Run checks on the class whose APIDoc is <code>doc</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The APIDoc of the class to check.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<a name="_check_var"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_check_var</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_var">source code</a></span>
</td>
</tr></table>
<p>Run checks on the variable whose documentation is <code>var</code> and
whose name is <code>name</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The documentation for the variable to check.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<a name="_check_func"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_check_func</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">doc</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="epydoc.checker-pysrc.html#DocChecker._check_func">source code</a></span>
</td>
</tr></table>
<p>Run checks on the function whose APIDoc is <code>doc</code>.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>doc</code></strong> (<a href="epydoc.apidoc.APIDoc-class.html" class="link">APIDoc</a>) - The APIDoc of the function to check.</li>
</ul></dd>
<dt>Returns: <code>None</code></dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
<a href="epydoc-log.html">Generated by Epydoc
3.0.1 on Wed Jan 30 14:07:35 2008</a>
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
