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
|
<?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</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="epydoc-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 3.0.1</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="epydoc-module.html">Package epydoc</a> ::
Module checker
</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-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="epydoc.checker-module.html">Module epydoc.checker</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># objdoc: epydoc documentation completeness checker</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Edward Loper</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Created [01/30/01 05:18 PM]</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># $Id: checker.py 1366 2006-09-07 15:54:59Z edloper $</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-docstring">Documentation completeness checker. This module defines a single</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-docstring">class, C{DocChecker}, which can be used to check the that specified</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-docstring">classes of objects are documented.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-name">__docformat__</tt> <tt class="py-op">=</tt> <tt class="py-string">'epytext en'</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment">##################################################</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Imports</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##################################################</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">re</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.path=epydoc.apidoc.ModuleDoc-class.html#path"><a title="epydoc.apidoc.ModuleDoc.path" class="py-name" href="#" onclick="return doclink('link-0', 'path', 'link-0');">path</a></tt><tt class="py-op">,</tt> <tt class="py-name">string</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt class="py-name">xml</tt><tt class="py-op">.</tt><tt class="py-name">dom</tt><tt class="py-op">.</tt><tt class="py-name">minidom</tt> <tt class="py-keyword">import</tt> <tt class="py-name">Text</tt> <tt class="py-name">as</tt> <tt class="py-name">_Text</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-1" class="py-name" targets="Package epydoc=epydoc-module.html"><a title="epydoc" class="py-name" href="#" onclick="return doclink('link-1', 'epydoc', 'link-1');">epydoc</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module epydoc.apidoc=epydoc.apidoc-module.html"><a title="epydoc.apidoc" class="py-name" href="#" onclick="return doclink('link-2', 'apidoc', 'link-2');">apidoc</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-comment"># The following methods may be undocumented:</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-3" class="py-name" targets="Variable epydoc.checker._NO_DOCS=epydoc.checker-module.html#_NO_DOCS"><a title="epydoc.checker._NO_DOCS" class="py-name" href="#" onclick="return doclink('link-3', '_NO_DOCS', 'link-3');">_NO_DOCS</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'__hash__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__repr__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__str__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__cmp__'</tt><tt class="py-op">]</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-comment"># The following methods never need descriptions, authors, or</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># versions:</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-4" class="py-name" targets="Variable epydoc.checker._NO_BASIC=epydoc.checker-module.html#_NO_BASIC"><a title="epydoc.checker._NO_BASIC" class="py-name" href="#" onclick="return doclink('link-4', '_NO_BASIC', 'link-4');">_NO_BASIC</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'__hash__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__repr__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__str__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__cmp__'</tt><tt class="py-op">]</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-comment"># The following methods never need return value descriptions.</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-5" class="py-name" targets="Variable epydoc.checker._NO_RETURN=epydoc.checker-module.html#_NO_RETURN"><a title="epydoc.checker._NO_RETURN" class="py-name" href="#" onclick="return doclink('link-5', '_NO_RETURN', 'link-5');">_NO_RETURN</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'__init__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__hash__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__repr__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__str__'</tt><tt class="py-op">,</tt> <tt class="py-string">'__cmp__'</tt><tt class="py-op">]</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt> <tt class="py-line"><tt class="py-comment"># The following methods don't need parameters documented:</tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"><tt class="py-comment"></tt><tt id="link-6" class="py-name" targets="Variable epydoc.checker._NO_PARAM=epydoc.checker-module.html#_NO_PARAM"><a title="epydoc.checker._NO_PARAM" class="py-name" href="#" onclick="return doclink('link-6', '_NO_PARAM', 'link-6');">_NO_PARAM</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-string">'__cmp__'</tt><tt class="py-op">]</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"> </tt>
<a name="DocChecker"></a><div id="DocChecker-def"><a name="L37"></a><tt class="py-lineno"> 37</tt> <a class="py-toggle" href="#" id="DocChecker-toggle" onclick="return toggle('DocChecker');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html">DocChecker</a><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="DocChecker-expanded"><a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"><tt class="py-docstring"> Documentation completeness checker. C{DocChecker} can be used to</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"><tt class="py-docstring"> check that specified classes of objects are documented. To check</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"><tt class="py-docstring"> the documentation for a group of objects, you should create a</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"><tt class="py-docstring"> C{DocChecker} from a L{DocIndex<apidoc.DocIndex>} that documents</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"><tt class="py-docstring"> those objects; and then use the L{check} method to run specified</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"><tt class="py-docstring"> checks on the objects' documentation.</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"><tt class="py-docstring"> What checks are run, and what objects they are run on, are</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt> <tt class="py-line"><tt class="py-docstring"> specified by the constants defined by C{DocChecker}. These</tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"><tt class="py-docstring"> constants are divided into three groups. </tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-docstring"> - Type specifiers indicate what type of objects should be</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-docstring"> checked: L{MODULE}; L{CLASS}; L{FUNC}; L{VAR}; L{IVAR};</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-docstring"> L{CVAR}; L{PARAM}; and L{RETURN}.</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"><tt class="py-docstring"> - Public/private specifiers indicate whether public or private</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"><tt class="py-docstring"> objects should be checked: L{PRIVATE}.</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"><tt class="py-docstring"> - Check specifiers indicate what checks should be run on the</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"><tt class="py-docstring"> objects: L{TYPE}; L{DESCR}; L{AUTHOR};</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"><tt class="py-docstring"> and L{VERSION}.</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt> <tt class="py-line"><tt class="py-docstring"> The L{check} method is used to perform a check on the</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"><tt class="py-docstring"> documentation. Its parameter is formed by or-ing together at</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"><tt class="py-docstring"> least one value from each specifier group:</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-docstring"> >>> checker.check(DocChecker.MODULE | DocChecker.DESCR)</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"><tt class="py-docstring"> To specify multiple values from a single group, simply or their</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"><tt class="py-docstring"> values together:</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"><tt class="py-docstring"> >>> checker.check(DocChecker.MODULE | DocChecker.CLASS |</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"><tt class="py-docstring"> ... DocChecker.FUNC )</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"><tt class="py-docstring"> @group Types: MODULE, CLASS, FUNC, VAR, IVAR, CVAR, PARAM,</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"><tt class="py-docstring"> RETURN, ALL_T</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"><tt class="py-docstring"> @type MODULE: C{int}</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"><tt class="py-docstring"> @cvar MODULE: Type specifier that indicates that the documentation</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"><tt class="py-docstring"> of modules should be checked.</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"><tt class="py-docstring"> @type CLASS: C{int}</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"><tt class="py-docstring"> @cvar CLASS: Type specifier that indicates that the documentation</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-docstring"> of classes should be checked.</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt> <tt class="py-line"><tt class="py-docstring"> @type FUNC: C{int}</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"><tt class="py-docstring"> @cvar FUNC: Type specifier that indicates that the documentation</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> of functions should be checked.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> @type VAR: C{int}</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> @cvar VAR: Type specifier that indicates that the documentation</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> of module variables should be checked.</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"><tt class="py-docstring"> @type IVAR: C{int}</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"><tt class="py-docstring"> @cvar IVAR: Type specifier that indicates that the documentation</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"><tt class="py-docstring"> of instance variables should be checked.</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"><tt class="py-docstring"> @type CVAR: C{int}</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"><tt class="py-docstring"> @cvar CVAR: Type specifier that indicates that the documentation</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"><tt class="py-docstring"> of class variables should be checked.</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"><tt class="py-docstring"> @type PARAM: C{int}</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"><tt class="py-docstring"> @cvar PARAM: Type specifier that indicates that the documentation</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt> <tt class="py-line"><tt class="py-docstring"> of function and method parameters should be checked.</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"><tt class="py-docstring"> @type RETURN: C{int}</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"><tt class="py-docstring"> @cvar RETURN: Type specifier that indicates that the documentation</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"><tt class="py-docstring"> of return values should be checked.</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"><tt class="py-docstring"> @type ALL_T: C{int}</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"><tt class="py-docstring"> @cvar ALL_T: Type specifier that indicates that the documentation</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"><tt class="py-docstring"> of all objects should be checked.</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"><tt class="py-docstring"> @group Checks: TYPE, AUTHOR, VERSION, DESCR, ALL_C</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"><tt class="py-docstring"> @type TYPE: C{int}</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"><tt class="py-docstring"> @cvar TYPE: Check specifier that indicates that every variable and</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"><tt class="py-docstring"> parameter should have a C{@type} field.</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"><tt class="py-docstring"> @type AUTHOR: C{int}</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"><tt class="py-docstring"> @cvar AUTHOR: Check specifier that indicates that every object</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt> <tt class="py-line"><tt class="py-docstring"> should have an C{author} field.</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"><tt class="py-docstring"> @type VERSION: C{int}</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> @cvar VERSION: Check specifier that indicates that every object</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> should have a C{version} field.</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> @type DESCR: C{int}</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> @cvar DESCR: Check specifier that indicates that every object</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> should have a description. </tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"><tt class="py-docstring"> @type ALL_C: C{int}</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"><tt class="py-docstring"> @cvar ALL_C: Check specifier that indicates that all checks</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"><tt class="py-docstring"> should be run.</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"><tt class="py-docstring"> @group Publicity: PRIVATE</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"><tt class="py-docstring"> @type PRIVATE: C{int}</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt> <tt class="py-line"><tt class="py-docstring"> @cvar PRIVATE: Specifier that indicates that private objects should</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"><tt class="py-docstring"> be checked.</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"> <tt class="py-comment"># Types</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-7" class="py-name" targets="Variable epydoc.checker.DocChecker.MODULE=epydoc.checker.DocChecker-class.html#MODULE"><a title="epydoc.checker.DocChecker.MODULE" class="py-name" href="#" onclick="return doclink('link-7', 'MODULE', 'link-7');">MODULE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt id="link-8" class="py-name" targets="Variable epydoc.checker.DocChecker.CLASS=epydoc.checker.DocChecker-class.html#CLASS"><a title="epydoc.checker.DocChecker.CLASS" class="py-name" href="#" onclick="return doclink('link-8', 'CLASS', 'link-8');">CLASS</a></tt> <tt class="py-op">=</tt> <tt class="py-number">2</tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> <tt id="link-9" class="py-name" targets="Variable epydoc.checker.DocChecker.FUNC=epydoc.checker.DocChecker-class.html#FUNC"><a title="epydoc.checker.DocChecker.FUNC" class="py-name" href="#" onclick="return doclink('link-9', 'FUNC', 'link-9');">FUNC</a></tt> <tt class="py-op">=</tt> <tt class="py-number">4</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt> <tt class="py-line"> <tt id="link-10" class="py-name" targets="Variable epydoc.checker.DocChecker.VAR=epydoc.checker.DocChecker-class.html#VAR"><a title="epydoc.checker.DocChecker.VAR" class="py-name" href="#" onclick="return doclink('link-10', 'VAR', 'link-10');">VAR</a></tt> <tt class="py-op">=</tt> <tt class="py-number">8</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-comment">#IVAR = 16</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-comment">#CVAR = 32</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-11" class="py-name" targets="Variable epydoc.checker.DocChecker.PARAM=epydoc.checker.DocChecker-class.html#PARAM"><a title="epydoc.checker.DocChecker.PARAM" class="py-name" href="#" onclick="return doclink('link-11', 'PARAM', 'link-11');">PARAM</a></tt> <tt class="py-op">=</tt> <tt class="py-number">64</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt id="link-12" class="py-name" targets="Variable epydoc.checker.DocChecker.RETURN=epydoc.checker.DocChecker-class.html#RETURN"><a title="epydoc.checker.DocChecker.RETURN" class="py-name" href="#" onclick="return doclink('link-12', 'RETURN', 'link-12');">RETURN</a></tt> <tt class="py-op">=</tt> <tt class="py-number">128</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt id="link-13" class="py-name" targets="Variable epydoc.checker.DocChecker.PROPERTY=epydoc.checker.DocChecker-class.html#PROPERTY"><a title="epydoc.checker.DocChecker.PROPERTY" class="py-name" href="#" onclick="return doclink('link-13', 'PROPERTY', 'link-13');">PROPERTY</a></tt> <tt class="py-op">=</tt> <tt class="py-number">256</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt id="link-14" class="py-name" targets="Variable epydoc.checker.DocChecker.ALL_T=epydoc.checker.DocChecker-class.html#ALL_T"><a title="epydoc.checker.DocChecker.ALL_T" class="py-name" href="#" onclick="return doclink('link-14', 'ALL_T', 'link-14');">ALL_T</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1</tt><tt class="py-op">+</tt><tt class="py-number">2</tt><tt class="py-op">+</tt><tt class="py-number">4</tt><tt class="py-op">+</tt><tt class="py-number">8</tt><tt class="py-op">+</tt><tt class="py-number">16</tt><tt class="py-op">+</tt><tt class="py-number">32</tt><tt class="py-op">+</tt><tt class="py-number">64</tt><tt class="py-op">+</tt><tt class="py-number">128</tt><tt class="py-op">+</tt><tt class="py-number">256</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"> <tt class="py-comment"># Checks</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-15" class="py-name" targets="Variable epydoc.checker.DocChecker.TYPE=epydoc.checker.DocChecker-class.html#TYPE"><a title="epydoc.checker.DocChecker.TYPE" class="py-name" href="#" onclick="return doclink('link-15', 'TYPE', 'link-15');">TYPE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">256</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"> <tt id="link-16" class="py-name" targets="Variable epydoc.checker.DocChecker.AUTHOR=epydoc.checker.DocChecker-class.html#AUTHOR"><a title="epydoc.checker.DocChecker.AUTHOR" class="py-name" href="#" onclick="return doclink('link-16', 'AUTHOR', 'link-16');">AUTHOR</a></tt> <tt class="py-op">=</tt> <tt class="py-number">1024</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"> <tt id="link-17" class="py-name" targets="Variable epydoc.checker.DocChecker.VERSION=epydoc.checker.DocChecker-class.html#VERSION"><a title="epydoc.checker.DocChecker.VERSION" class="py-name" href="#" onclick="return doclink('link-17', 'VERSION', 'link-17');">VERSION</a></tt> <tt class="py-op">=</tt> <tt class="py-number">2048</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt> <tt class="py-line"> <tt id="link-18" class="py-name" targets="Variable epydoc.checker.DocChecker.DESCR=epydoc.checker.DocChecker-class.html#DESCR"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-18', 'DESCR', 'link-18');">DESCR</a></tt> <tt class="py-op">=</tt> <tt class="py-number">4096</tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt id="link-19" class="py-name" targets="Variable epydoc.checker.DocChecker.ALL_C=epydoc.checker.DocChecker-class.html#ALL_C"><a title="epydoc.checker.DocChecker.ALL_C" class="py-name" href="#" onclick="return doclink('link-19', 'ALL_C', 'link-19');">ALL_C</a></tt> <tt class="py-op">=</tt> <tt class="py-number">256</tt><tt class="py-op">+</tt><tt class="py-number">512</tt><tt class="py-op">+</tt><tt class="py-number">1024</tt><tt class="py-op">+</tt><tt class="py-number">2048</tt><tt class="py-op">+</tt><tt class="py-number">4096</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-comment"># Private/public</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt id="link-20" class="py-name" targets="Variable epydoc.checker.DocChecker.PRIVATE=epydoc.checker.DocChecker-class.html#PRIVATE"><a title="epydoc.checker.DocChecker.PRIVATE" class="py-name" href="#" onclick="return doclink('link-20', 'PRIVATE', 'link-20');">PRIVATE</a></tt> <tt class="py-op">=</tt> <tt class="py-number">16384</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt id="link-21" class="py-name" targets="Variable epydoc.checker.DocChecker.ALL=epydoc.checker.DocChecker-class.html#ALL"><a title="epydoc.checker.DocChecker.ALL" class="py-name" href="#" onclick="return doclink('link-21', 'ALL', 'link-21');">ALL</a></tt> <tt class="py-op">=</tt> <tt id="link-22" class="py-name"><a title="epydoc.checker.DocChecker.ALL_T" class="py-name" href="#" onclick="return doclink('link-22', 'ALL_T', 'link-14');">ALL_T</a></tt> <tt class="py-op">+</tt> <tt id="link-23" class="py-name"><a title="epydoc.checker.DocChecker.ALL_C" class="py-name" href="#" onclick="return doclink('link-23', 'ALL_C', 'link-19');">ALL_C</a></tt> <tt class="py-op">+</tt> <tt id="link-24" class="py-name"><a title="epydoc.checker.DocChecker.PRIVATE" class="py-name" href="#" onclick="return doclink('link-24', 'PRIVATE', 'link-20');">PRIVATE</a></tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> </tt>
<a name="DocChecker.__init__"></a><div id="DocChecker.__init__-def"><a name="L147"></a><tt class="py-lineno">147</tt> <a class="py-toggle" href="#" id="DocChecker.__init__-toggle" onclick="return toggle('DocChecker.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">docindex</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker.__init__-expanded"><a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"><tt class="py-docstring"> Create a new C{DocChecker} that can be used to run checks on</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"><tt class="py-docstring"> the documentation of the objects documented by C{docindex}</tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt> <tt class="py-line"><tt class="py-docstring"> @param docindex: A documentation map containing the</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"><tt class="py-docstring"> documentation for the objects to be checked.</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> @type docindex: L{Docindex<apidoc.DocIndex>}</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_docindex</tt> <tt class="py-op">=</tt> <tt class="py-name">docindex</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> <tt class="py-comment"># Initialize instance variables</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_last_warn</tt> <tt class="py-op">=</tt> <tt class="py-name">None</tt> </tt>
<a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_out</tt> <tt class="py-op">=</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_num_warnings</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
</div><a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> </tt>
<a name="DocChecker.check"></a><div id="DocChecker.check-def"><a name="L164"></a><tt class="py-lineno">164</tt> <a class="py-toggle" href="#" id="DocChecker.check-toggle" onclick="return toggle('DocChecker.check');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#check">check</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">check_sets</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker.check-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker.check-expanded"><a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"><tt class="py-docstring"> Run the specified checks on the documentation of the objects</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"><tt class="py-docstring"> contained by this C{DocChecker}'s C{DocIndex}. Any errors found</tt> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt> <tt class="py-line"><tt class="py-docstring"> are printed to standard out.</tt> </tt>
<a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"><tt class="py-docstring"> @param check_sets: The checks that should be run on the</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"><tt class="py-docstring"> documentation. This value is constructed by or-ing</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt> <tt class="py-line"><tt class="py-docstring"> together the specifiers that indicate which objects should</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"><tt class="py-docstring"> be checked, and which checks should be run. See the</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> L{module description<checker>} for more information.</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> If no checks are specified, then a default set of checks</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"><tt class="py-docstring"> will be run.</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"><tt class="py-docstring"> @type check_sets: C{int}</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"><tt class="py-docstring"> @return: True if no problems were found.</tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{boolean}</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">check_sets</tt><tt class="py-op">:</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-name">check_sets</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt id="link-25" class="py-name" targets="Class epydoc.checker.DocChecker=epydoc.checker.DocChecker-class.html"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-25', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="epydoc.checker.DocChecker.MODULE" class="py-name" href="#" onclick="return doclink('link-26', 'MODULE', 'link-7');">MODULE</a></tt> <tt class="py-op">|</tt> <tt id="link-27" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-27', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="epydoc.checker.DocChecker.CLASS" class="py-name" href="#" onclick="return doclink('link-28', 'CLASS', 'link-8');">CLASS</a></tt> <tt class="py-op">|</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> <tt id="link-29" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-29', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="epydoc.checker.DocChecker.FUNC" class="py-name" href="#" onclick="return doclink('link-30', 'FUNC', 'link-9');">FUNC</a></tt> <tt class="py-op">|</tt> <tt id="link-31" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-31', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="epydoc.checker.DocChecker.VAR" class="py-name" href="#" onclick="return doclink('link-32', 'VAR', 'link-10');">VAR</a></tt> <tt class="py-op">|</tt> </tt>
<a name="L184"></a><tt class="py-lineno">184</tt> <tt class="py-line"> <tt id="link-33" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-33', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-34', 'DESCR', 'link-18');">DESCR</a></tt><tt class="py-op">,</tt><tt class="py-op">)</tt> </tt>
<a name="L185"></a><tt class="py-lineno">185</tt> <tt class="py-line"> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_warnings</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt> <tt class="py-line"> <tt id="link-35" class="py-name" targets="Method epydoc.cli.ConsoleLogger.log()=epydoc.cli.ConsoleLogger-class.html#log,Method epydoc.cli.HTMLLogger.log()=epydoc.cli.HTMLLogger-class.html#log,Method epydoc.gui.GUILogger.log()=epydoc.gui.GUILogger-class.html#log,Module epydoc.log=epydoc.log-module.html,Method epydoc.log.Logger.log()=epydoc.log.Logger-class.html#log,Method epydoc.log.SimpleLogger.log()=epydoc.log.SimpleLogger-class.html#log"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-35', 'log', 'link-35');">log</a></tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method epydoc.cli.ConsoleLogger.start_progress()=epydoc.cli.ConsoleLogger-class.html#start_progress,Method epydoc.cli.UnifiedProgressConsoleLogger.start_progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#start_progress,Method epydoc.gui.GUILogger.start_progress()=epydoc.gui.GUILogger-class.html#start_progress,Method epydoc.log.Logger.start_progress()=epydoc.log.Logger-class.html#start_progress,Function epydoc.log.start_progress()=epydoc.log-module.html#start_progress"><a title="epydoc.cli.ConsoleLogger.start_progress
epydoc.cli.UnifiedProgressConsoleLogger.start_progress
epydoc.gui.GUILogger.start_progress
epydoc.log.Logger.start_progress
epydoc.log.start_progress" class="py-name" href="#" onclick="return doclink('link-36', 'start_progress', 'link-36');">start_progress</a></tt><tt class="py-op">(</tt><tt class="py-string">'Checking docs'</tt><tt class="py-op">)</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">j</tt><tt class="py-op">,</tt> <tt class="py-name">checks</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt class="py-name">check_sets</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Method epydoc.checker.DocChecker._check()=epydoc.checker.DocChecker-class.html#_check,Function epydoc.docstringparser._check()=epydoc.docstringparser-module.html#_check"><a title="epydoc.checker.DocChecker._check
epydoc.docstringparser._check" class="py-name" href="#" onclick="return doclink('link-37', '_check', 'link-37');">_check</a></tt><tt class="py-op">(</tt><tt class="py-name">checks</tt><tt class="py-op">)</tt> </tt>
<a name="L190"></a><tt class="py-lineno">190</tt> <tt class="py-line"> <tt id="link-38" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-38', 'log', 'link-35');">log</a></tt><tt class="py-op">.</tt><tt id="link-39" class="py-name" targets="Method epydoc.cli.ConsoleLogger.end_progress()=epydoc.cli.ConsoleLogger-class.html#end_progress,Method epydoc.cli.UnifiedProgressConsoleLogger.end_progress()=epydoc.cli.UnifiedProgressConsoleLogger-class.html#end_progress,Method epydoc.gui.GUILogger.end_progress()=epydoc.gui.GUILogger-class.html#end_progress,Method epydoc.log.Logger.end_progress()=epydoc.log.Logger-class.html#end_progress,Function epydoc.log.end_progress()=epydoc.log-module.html#end_progress"><a title="epydoc.cli.ConsoleLogger.end_progress
epydoc.cli.UnifiedProgressConsoleLogger.end_progress
epydoc.gui.GUILogger.end_progress
epydoc.log.Logger.end_progress
epydoc.log.end_progress" class="py-name" href="#" onclick="return doclink('link-39', 'end_progress', 'link-39');">end_progress</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L191"></a><tt class="py-lineno">191</tt> <tt class="py-line"> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-op">(</tt><tt id="link-40" class="py-name" targets="Method epydoc.checker.DocChecker.warning()=epydoc.checker.DocChecker-class.html#warning,Function epydoc.log.warning()=epydoc.log-module.html#warning"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-40', 'warning', 'link-40');">warning</a></tt><tt class="py-op">,</tt> <tt class="py-name">docs</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_warnings</tt><tt class="py-op">.</tt><tt class="py-name">items</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt id="link-41" class="py-name" targets="Function epydoc.compat.sorted()=epydoc.compat-module.html#sorted"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-41', 'sorted', 'link-41');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt> <tt class="py-line"> <tt class="py-name">docnames</tt> <tt class="py-op">=</tt> <tt class="py-string">'\n'</tt><tt class="py-op">.</tt><tt class="py-name">join</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-string">' - %s'</tt> <tt class="py-op">%</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name" targets="Method epydoc.checker.DocChecker._name()=epydoc.checker.DocChecker-class.html#_name"><a title="epydoc.checker.DocChecker._name" class="py-name" href="#" onclick="return doclink('link-42', '_name', 'link-42');">_name</a></tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">docs</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt> <tt class="py-line"> <tt id="link-43" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-43', 'log', 'link-35');">log</a></tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-44', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'%s:\n%s'</tt> <tt class="py-op">%</tt> <tt class="py-op">(</tt><tt id="link-45" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-45', 'warning', 'link-40');">warning</a></tt><tt class="py-op">,</tt> <tt class="py-name">docnames</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L196"></a><tt class="py-lineno">196</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check"></a><div id="DocChecker._check-def"><a name="L197"></a><tt class="py-lineno">197</tt> <a class="py-toggle" href="#" id="DocChecker._check-toggle" onclick="return toggle('DocChecker._check');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check">_check</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">checks</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check-expanded"><a name="L198"></a><tt class="py-lineno">198</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">=</tt> <tt class="py-name">checks</tt> </tt>
<a name="L199"></a><tt class="py-lineno">199</tt> <tt class="py-line"> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt> <tt class="py-line"> <tt class="py-comment"># Get the list of objects to check.</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt> <tt class="py-line"><tt class="py-comment"></tt> <tt class="py-name">valdocs</tt> <tt class="py-op">=</tt> <tt id="link-46" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-46', 'sorted', 'link-41');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_docindex</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name" targets="Method epydoc.apidoc.DocIndex.reachable_valdocs()=epydoc.apidoc.DocIndex-class.html#reachable_valdocs,Function epydoc.apidoc.reachable_valdocs()=epydoc.apidoc-module.html#reachable_valdocs"><a title="epydoc.apidoc.DocIndex.reachable_valdocs
epydoc.apidoc.reachable_valdocs" class="py-name" href="#" onclick="return doclink('link-47', 'reachable_valdocs', 'link-47');">reachable_valdocs</a></tt><tt class="py-op">(</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt> <tt class="py-line"> <tt id="link-48" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.imports=epydoc.apidoc.ModuleDoc-class.html#imports"><a title="epydoc.apidoc.ModuleDoc.imports" class="py-name" href="#" onclick="return doclink('link-48', 'imports', 'link-48');">imports</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">packages</tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-49" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.bases=epydoc.apidoc.ClassDoc-class.html#bases"><a title="epydoc.apidoc.ClassDoc.bases" class="py-name" href="#" onclick="return doclink('link-49', 'bases', 'link-49');">bases</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt id="link-50" class="py-name" targets="Variable epydoc.apidoc.ModuleDoc.submodules=epydoc.apidoc.ModuleDoc-class.html#submodules"><a title="epydoc.apidoc.ModuleDoc.submodules" class="py-name" href="#" onclick="return doclink('link-50', 'submodules', 'link-50');">submodules</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt> <tt class="py-line"> <tt id="link-51" class="py-name" targets="Variable epydoc.apidoc.ClassDoc.subclasses=epydoc.apidoc.ClassDoc-class.html#subclasses"><a title="epydoc.apidoc.ClassDoc.subclasses" class="py-name" href="#" onclick="return doclink('link-51', 'subclasses', 'link-51');">subclasses</a></tt><tt class="py-op">=</tt><tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">private</tt> <tt class="py-op">=</tt> <tt class="py-op">(</tt><tt class="py-name">checks</tt> <tt class="py-op">&</tt> <tt id="link-52" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-52', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-53" class="py-name"><a title="epydoc.checker.DocChecker.PRIVATE" class="py-name" href="#" onclick="return doclink('link-53', 'PRIVATE', 'link-20');">PRIVATE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt> <tt class="py-line"> <tt class="py-name">docs</tt> <tt class="py-op">=</tt> <tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">,</tt> <tt id="link-54" class="py-name" targets="Class epydoc.apidoc.GenericValueDoc=epydoc.apidoc.GenericValueDoc-class.html"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-54', 'GenericValueDoc', 'link-54');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">valdocs</tt><tt class="py-op">:</tt> </tt>
<a name="L208"></a><tt class="py-lineno">208</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-55" class="py-name" targets="Class epydoc.apidoc.NamespaceDoc=epydoc.apidoc.NamespaceDoc-class.html"><a title="epydoc.apidoc.NamespaceDoc" class="py-name" href="#" onclick="return doclink('link-55', 'NamespaceDoc', 'link-55');">NamespaceDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L209"></a><tt class="py-lineno">209</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">d</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-56" class="py-name" targets="Variable epydoc.apidoc.NamespaceDoc.variables=epydoc.apidoc.NamespaceDoc-class.html#variables"><a title="epydoc.apidoc.NamespaceDoc.variables" class="py-name" href="#" onclick="return doclink('link-56', 'variables', 'link-56');">variables</a></tt><tt class="py-op">.</tt><tt class="py-name">values</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.value=epydoc.apidoc.VariableDoc-class.html#value"><a title="epydoc.apidoc.VariableDoc.value" class="py-name" href="#" onclick="return doclink('link-57', 'value', 'link-57');">value</a></tt><tt class="py-op">,</tt> <tt id="link-58" class="py-name"><a title="epydoc.apidoc.GenericValueDoc" class="py-name" href="#" onclick="return doclink('link-58', 'GenericValueDoc', 'link-54');">GenericValueDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">docs</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">d</tt><tt class="py-op">)</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt> <tt class="py-line"> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt> <tt class="py-keyword">in</tt> <tt class="py-name">enumerate</tt><tt class="py-op">(</tt><tt id="link-59" class="py-name"><a title="epydoc.compat.sorted" class="py-name" href="#" onclick="return doclink('link-59', 'sorted', 'link-41');">sorted</a></tt><tt class="py-op">(</tt><tt class="py-name">docs</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-60" class="py-name" targets="Class epydoc.apidoc.ModuleDoc=epydoc.apidoc.ModuleDoc-class.html"><a title="epydoc.apidoc.ModuleDoc" class="py-name" href="#" onclick="return doclink('link-60', 'ModuleDoc', 'link-60');">ModuleDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L214"></a><tt class="py-lineno">214</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method epydoc.checker.DocChecker._check_module()=epydoc.checker.DocChecker-class.html#_check_module"><a title="epydoc.checker.DocChecker._check_module" class="py-name" href="#" onclick="return doclink('link-61', '_check_module', 'link-61');">_check_module</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L215"></a><tt class="py-lineno">215</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-62" class="py-name" targets="Class epydoc.apidoc.ClassDoc=epydoc.apidoc.ClassDoc-class.html"><a title="epydoc.apidoc.ClassDoc" class="py-name" href="#" onclick="return doclink('link-62', 'ClassDoc', 'link-62');">ClassDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-63" class="py-name" targets="Method epydoc.checker.DocChecker._check_class()=epydoc.checker.DocChecker-class.html#_check_class"><a title="epydoc.checker.DocChecker._check_class" class="py-name" href="#" onclick="return doclink('link-63', '_check_class', 'link-63');">_check_class</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-64" class="py-name" targets="Class epydoc.apidoc.RoutineDoc=epydoc.apidoc.RoutineDoc-class.html"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-64', 'RoutineDoc', 'link-64');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-65" class="py-name" targets="Method epydoc.checker.DocChecker._check_func()=epydoc.checker.DocChecker-class.html#_check_func"><a title="epydoc.checker.DocChecker._check_func" class="py-name" href="#" onclick="return doclink('link-65', '_check_func', 'link-65');">_check_func</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-66" class="py-name" targets="Class epydoc.apidoc.PropertyDoc=epydoc.apidoc.PropertyDoc-class.html"><a title="epydoc.apidoc.PropertyDoc" class="py-name" href="#" onclick="return doclink('link-66', 'PropertyDoc', 'link-66');">PropertyDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name" targets="Method epydoc.checker.DocChecker._check_property()=epydoc.checker.DocChecker-class.html#_check_property"><a title="epydoc.checker.DocChecker._check_property" class="py-name" href="#" onclick="return doclink('link-67', '_check_property', 'link-67');">_check_property</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-68" class="py-name" targets="Class epydoc.apidoc.VariableDoc=epydoc.apidoc.VariableDoc-class.html"><a title="epydoc.apidoc.VariableDoc" class="py-name" href="#" onclick="return doclink('link-68', 'VariableDoc', 'link-68');">VariableDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Method epydoc.checker.DocChecker._check_var()=epydoc.checker.DocChecker-class.html#_check_var"><a title="epydoc.checker.DocChecker._check_var" class="py-name" href="#" onclick="return doclink('link-69', '_check_var', 'link-69');">_check_var</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L223"></a><tt class="py-lineno">223</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt> <tt class="py-line"> <tt id="link-70" class="py-name"><a title="epydoc.cli.ConsoleLogger.log
epydoc.cli.HTMLLogger.log
epydoc.gui.GUILogger.log
epydoc.log
epydoc.log.Logger.log
epydoc.log.SimpleLogger.log" class="py-name" href="#" onclick="return doclink('link-70', 'log', 'link-35');">log</a></tt><tt class="py-op">.</tt><tt id="link-71" class="py-name" targets="Function epydoc.log.error()=epydoc.log-module.html#error"><a title="epydoc.log.error" class="py-name" href="#" onclick="return doclink('link-71', 'error', 'link-71');">error</a></tt><tt class="py-op">(</tt><tt class="py-string">"Don't know how to check %r"</tt> <tt class="py-op">%</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L225"></a><tt class="py-lineno">225</tt> <tt class="py-line"> </tt>
<a name="DocChecker._name"></a><div id="DocChecker._name-def"><a name="L226"></a><tt class="py-lineno">226</tt> <a class="py-toggle" href="#" id="DocChecker._name-toggle" onclick="return toggle('DocChecker._name');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_name">_name</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._name-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._name-expanded"><a name="L227"></a><tt class="py-lineno">227</tt> <tt class="py-line"> <tt id="link-72" class="py-name" targets="Variable epydoc.apidoc.VariableDoc.name=epydoc.apidoc.VariableDoc-class.html#name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-72', 'name', 'link-72');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name" targets="Variable epydoc.apidoc.GenericValueDoc.canonical_name=epydoc.apidoc.GenericValueDoc-class.html#canonical_name,Variable epydoc.apidoc.ValueDoc.canonical_name=epydoc.apidoc.ValueDoc-class.html#canonical_name,Variable epydoc.apidoc.VariableDoc.canonical_name=epydoc.apidoc.VariableDoc-class.html#canonical_name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-73', 'canonical_name', 'link-73');">canonical_name</a></tt><tt class="py-op">)</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">,</tt> <tt id="link-74" class="py-name"><a title="epydoc.apidoc.RoutineDoc" class="py-name" href="#" onclick="return doclink('link-74', 'RoutineDoc', 'link-64');">RoutineDoc</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-75" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-75', 'name', 'link-72');">name</a></tt> <tt class="py-op">+=</tt> <tt class="py-string">'()'</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-76" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-76', 'name', 'link-72');">name</a></tt> </tt>
</div><a name="L230"></a><tt class="py-lineno">230</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_basic"></a><div id="DocChecker._check_basic-def"><a name="L231"></a><tt class="py-lineno">231</tt> <a class="py-toggle" href="#" id="DocChecker._check_basic-toggle" onclick="return toggle('DocChecker._check_basic');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_basic">_check_basic</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_basic-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_basic-expanded"><a name="L232"></a><tt class="py-lineno">232</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt> <tt class="py-line"><tt class="py-docstring"> Check the description, author, version, and see-also fields of</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt> <tt class="py-line"><tt class="py-docstring"> C{doc}. This is used as a helper function by L{_check_module},</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt> <tt class="py-line"><tt class="py-docstring"> L{_check_class}, and L{_check_func}.</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L237"></a><tt class="py-lineno">237</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The documentation that should be checked.</tt> </tt>
<a name="L238"></a><tt class="py-lineno">238</tt> <tt class="py-line"><tt class="py-docstring"> @type doc: L{APIDoc}</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-77" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-77', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-78" class="py-name"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-78', 'DESCR', 'link-18');">DESCR</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt> <tt class="py-line"> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name" targets="Variable epydoc.apidoc.APIDoc.descr=epydoc.apidoc.APIDoc-class.html#descr,Variable epydoc.cli.descr=epydoc.cli-module.html#descr,Method epydoc.docwriter.html.HTMLWriter.descr()=epydoc.docwriter.html.HTMLWriter-class.html#descr,Method epydoc.markup.ParseError.descr()=epydoc.markup.ParseError-class.html#descr,Method epydoc.markup.epytext.ColorizingError.descr()=epydoc.markup.epytext.ColorizingError-class.html#descr"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-79', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-80" class="py-name" targets="Variable epydoc.apidoc.UNKNOWN=epydoc.apidoc-module.html#UNKNOWN"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-80', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name" targets="Variable epydoc.apidoc.APIDoc.docstring=epydoc.apidoc.APIDoc-class.html#docstring"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-81', 'docstring', 'link-81');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-82" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-82', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-83', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Undocumented'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L245"></a><tt class="py-lineno">245</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L246"></a><tt class="py-lineno">246</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-84" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-84', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No description'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-85" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-85', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-86" class="py-name"><a title="epydoc.checker.DocChecker.AUTHOR" class="py-name" href="#" onclick="return doclink('link-86', 'AUTHOR', 'link-16');">AUTHOR</a></tt><tt class="py-op">:</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-87" class="py-name" targets="Method epydoc.markup.Field.tag()=epydoc.markup.Field-class.html#tag"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-87', 'tag', 'link-87');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-88" class="py-name" targets="Method epydoc.markup.Field.arg()=epydoc.markup.Field-class.html#arg"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-88', 'arg', 'link-88');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-89" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-89', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name" targets="Variable epydoc.apidoc.APIDoc.metadata=epydoc.apidoc.APIDoc-class.html#metadata"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-90', 'metadata', 'link-90');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'author'</tt> <tt class="py-op">==</tt> <tt id="link-91" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-91', 'tag', 'link-87');">tag</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L251"></a><tt class="py-lineno">251</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-92" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-92', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No authors'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-93" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-93', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-94" class="py-name"><a title="epydoc.checker.DocChecker.VERSION" class="py-name" href="#" onclick="return doclink('link-94', 'VERSION', 'link-17');">VERSION</a></tt><tt class="py-op">:</tt> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-95" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-95', 'tag', 'link-87');">tag</a></tt><tt class="py-op">,</tt> <tt id="link-96" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-96', 'arg', 'link-88');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-97" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-97', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-98" class="py-name"><a title="epydoc.apidoc.APIDoc.metadata" class="py-name" href="#" onclick="return doclink('link-98', 'metadata', 'link-90');">metadata</a></tt><tt class="py-op">:</tt> </tt>
<a name="L254"></a><tt class="py-lineno">254</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-string">'version'</tt> <tt class="py-op">==</tt> <tt id="link-99" class="py-name"><a title="epydoc.markup.Field.tag" class="py-name" href="#" onclick="return doclink('link-99', 'tag', 'link-87');">tag</a></tt><tt class="py-op">:</tt> <tt class="py-keyword">break</tt> </tt>
<a name="L255"></a><tt class="py-lineno">255</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-100', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No version'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L257"></a><tt class="py-lineno">257</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_module"></a><div id="DocChecker._check_module-def"><a name="L258"></a><tt class="py-lineno">258</tt> <a class="py-toggle" href="#" id="DocChecker._check_module-toggle" onclick="return toggle('DocChecker._check_module');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_module">_check_module</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_module-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_module-expanded"><a name="L259"></a><tt class="py-lineno">259</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt> <tt class="py-line"><tt class="py-docstring"> Run checks on the module whose APIDoc is C{doc}.</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The APIDoc of the module to check.</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt> <tt class="py-line"><tt class="py-docstring"> @type doc: L{APIDoc}</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-101" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-101', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="epydoc.checker.DocChecker.MODULE" class="py-name" href="#" onclick="return doclink('link-102', 'MODULE', 'link-7');">MODULE</a></tt><tt class="py-op">:</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name" targets="Method epydoc.checker.DocChecker._check_basic()=epydoc.checker.DocChecker-class.html#_check_basic"><a title="epydoc.checker.DocChecker._check_basic" class="py-name" href="#" onclick="return doclink('link-103', '_check_basic', 'link-103');">_check_basic</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L268"></a><tt class="py-lineno">268</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_class"></a><div id="DocChecker._check_class-def"><a name="L269"></a><tt class="py-lineno">269</tt> <a class="py-toggle" href="#" id="DocChecker._check_class-toggle" onclick="return toggle('DocChecker._check_class');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_class">_check_class</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_class-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_class-expanded"><a name="L270"></a><tt class="py-lineno">270</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt> <tt class="py-line"><tt class="py-docstring"> Run checks on the class whose APIDoc is C{doc}.</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The APIDoc of the class to check.</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt> <tt class="py-line"><tt class="py-docstring"> @type doc: L{APIDoc}</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-104" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-104', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="epydoc.checker.DocChecker.CLASS" class="py-name" href="#" onclick="return doclink('link-105', 'CLASS', 'link-8');">CLASS</a></tt><tt class="py-op">:</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-106" class="py-name"><a title="epydoc.checker.DocChecker._check_basic" class="py-name" href="#" onclick="return doclink('link-106', '_check_basic', 'link-103');">_check_basic</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L279"></a><tt class="py-lineno">279</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_property"></a><div id="DocChecker._check_property-def"><a name="L280"></a><tt class="py-lineno">280</tt> <a class="py-toggle" href="#" id="DocChecker._check_property-toggle" onclick="return toggle('DocChecker._check_property');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_property">_check_property</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_property-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_property-expanded"><a name="L281"></a><tt class="py-lineno">281</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-107" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-107', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-108" class="py-name"><a title="epydoc.checker.DocChecker.PROPERTY" class="py-name" href="#" onclick="return doclink('link-108', 'PROPERTY', 'link-13');">PROPERTY</a></tt><tt class="py-op">:</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-109" class="py-name"><a title="epydoc.checker.DocChecker._check_basic" class="py-name" href="#" onclick="return doclink('link-109', '_check_basic', 'link-103');">_check_basic</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L283"></a><tt class="py-lineno">283</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_var"></a><div id="DocChecker._check_var-def"><a name="L284"></a><tt class="py-lineno">284</tt> <a class="py-toggle" href="#" id="DocChecker._check_var-toggle" onclick="return toggle('DocChecker._check_var');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_var">_check_var</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_var-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_var-expanded"><a name="L285"></a><tt class="py-lineno">285</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt> <tt class="py-line"><tt class="py-docstring"> Run checks on the variable whose documentation is C{var} and</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt> <tt class="py-line"><tt class="py-docstring"> whose name is C{name}.</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The documentation for the variable to check.</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt> <tt class="py-line"><tt class="py-docstring"> @type doc: L{APIDoc}</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-110" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-110', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="epydoc.checker.DocChecker.VAR" class="py-name" href="#" onclick="return doclink('link-111', 'VAR', 'link-10');">VAR</a></tt><tt class="py-op">:</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt class="py-op">(</tt><tt id="link-112" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-112', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-113" class="py-name"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-113', 'DESCR', 'link-18');">DESCR</a></tt><tt class="py-op">|</tt><tt id="link-114" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-114', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-115" class="py-name"><a title="epydoc.checker.DocChecker.TYPE" class="py-name" href="#" onclick="return doclink('link-115', 'TYPE', 'link-15');">TYPE</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-116" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-116', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-117" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-117', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L296"></a><tt class="py-lineno">296</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-118" class="py-name" targets="Variable epydoc.apidoc.PropertyDoc.type_descr=epydoc.apidoc.PropertyDoc-class.html#type_descr,Variable epydoc.apidoc.VariableDoc.type_descr=epydoc.apidoc.VariableDoc-class.html#type_descr,Method epydoc.docwriter.html.HTMLWriter.type_descr()=epydoc.docwriter.html.HTMLWriter-class.html#type_descr"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-118', 'type_descr', 'link-118');">type_descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-119" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-119', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L297"></a><tt class="py-lineno">297</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-120" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-120', 'docstring', 'link-81');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-121" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-121', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-122" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-122', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Undocumented'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-123" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-123', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-124" class="py-name"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-124', 'DESCR', 'link-18');">DESCR</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-125" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-125', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-126" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-126', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-127" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-127', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No description'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-128" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-128', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-129" class="py-name"><a title="epydoc.checker.DocChecker.TYPE" class="py-name" href="#" onclick="return doclink('link-129', 'TYPE', 'link-15');">TYPE</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-130" class="py-name"><a title="epydoc.apidoc.PropertyDoc.type_descr
epydoc.apidoc.VariableDoc.type_descr
epydoc.docwriter.html.HTMLWriter.type_descr" class="py-name" href="#" onclick="return doclink('link-130', 'type_descr', 'link-118');">type_descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-131" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-131', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-132" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-132', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No type information'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L306"></a><tt class="py-lineno">306</tt> <tt class="py-line"> </tt>
<a name="DocChecker._check_func"></a><div id="DocChecker._check_func-def"><a name="L307"></a><tt class="py-lineno">307</tt> <a class="py-toggle" href="#" id="DocChecker._check_func-toggle" onclick="return toggle('DocChecker._check_func');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#_check_func">_check_func</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker._check_func-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker._check_func-expanded"><a name="L308"></a><tt class="py-lineno">308</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt>
<a name="L309"></a><tt class="py-lineno">309</tt> <tt class="py-line"><tt class="py-docstring"> Run checks on the function whose APIDoc is C{doc}.</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt> <tt class="py-line"><tt class="py-docstring"> @param doc: The APIDoc of the function to check.</tt> </tt>
<a name="L312"></a><tt class="py-lineno">312</tt> <tt class="py-line"><tt class="py-docstring"> @type doc: L{APIDoc}</tt> </tt>
<a name="L313"></a><tt class="py-lineno">313</tt> <tt class="py-line"><tt class="py-docstring"> @rtype: C{None}</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt> <tt class="py-line"> <tt id="link-133" class="py-name"><a title="epydoc.apidoc.VariableDoc.name" class="py-name" href="#" onclick="return doclink('link-133', 'name', 'link-72');">name</a></tt> <tt class="py-op">=</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-134" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-134', 'canonical_name', 'link-73');">canonical_name</a></tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-135" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-135', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-136" class="py-name"><a title="epydoc.checker.DocChecker.FUNC" class="py-name" href="#" onclick="return doclink('link-136', 'FUNC', 'link-9');">FUNC</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-137" class="py-name"><a title="epydoc.apidoc.APIDoc.docstring" class="py-name" href="#" onclick="return doclink('link-137', 'docstring', 'link-81');">docstring</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-138" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-138', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-139" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-139', 'canonical_name', 'link-73');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-140" class="py-name"><a title="epydoc.checker._NO_DOCS" class="py-name" href="#" onclick="return doclink('link-140', '_NO_DOCS', 'link-3');">_NO_DOCS</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L319"></a><tt class="py-lineno">319</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-141" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-141', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Undocumented'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L320"></a><tt class="py-lineno">320</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-142" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-142', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-143" class="py-name"><a title="epydoc.checker.DocChecker.FUNC" class="py-name" href="#" onclick="return doclink('link-143', 'FUNC', 'link-9');">FUNC</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-144" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-144', 'canonical_name', 'link-73');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-145" class="py-name"><a title="epydoc.checker._NO_BASIC" class="py-name" href="#" onclick="return doclink('link-145', '_NO_BASIC', 'link-4');">_NO_BASIC</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L323"></a><tt class="py-lineno">323</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-146" class="py-name"><a title="epydoc.checker.DocChecker._check_basic" class="py-name" href="#" onclick="return doclink('link-146', '_check_basic', 'link-103');">_check_basic</a></tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L324"></a><tt class="py-lineno">324</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-147" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-147', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-148" class="py-name"><a title="epydoc.checker.DocChecker.RETURN" class="py-name" href="#" onclick="return doclink('link-148', 'RETURN', 'link-12');">RETURN</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-149" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-149', 'canonical_name', 'link-73');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-150" class="py-name"><a title="epydoc.checker._NO_RETURN" class="py-name" href="#" onclick="return doclink('link-150', '_NO_RETURN', 'link-5');">_NO_RETURN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-151" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_type=epydoc.apidoc.RoutineDoc-class.html#return_type,Method epydoc.docwriter.html.HTMLWriter.return_type()=epydoc.docwriter.html.HTMLWriter-class.html#return_type"><a title="epydoc.apidoc.RoutineDoc.return_type
epydoc.docwriter.html.HTMLWriter.return_type" class="py-name" href="#" onclick="return doclink('link-151', 'return_type', 'link-151');">return_type</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-152" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-152', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-153" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.return_descr=epydoc.apidoc.RoutineDoc-class.html#return_descr,Method epydoc.docwriter.html.HTMLWriter.return_descr()=epydoc.docwriter.html.HTMLWriter-class.html#return_descr"><a title="epydoc.apidoc.RoutineDoc.return_descr
epydoc.docwriter.html.HTMLWriter.return_descr" class="py-name" href="#" onclick="return doclink('link-153', 'return_descr', 'link-153');">return_descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-154" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-154', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-155" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-155', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No return descr'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-156" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-156', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-157" class="py-name"><a title="epydoc.checker.DocChecker.PARAM" class="py-name" href="#" onclick="return doclink('link-157', 'PARAM', 'link-11');">PARAM</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L330"></a><tt class="py-lineno">330</tt> <tt class="py-line"> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-158" class="py-name"><a title="epydoc.apidoc.GenericValueDoc.canonical_name
epydoc.apidoc.ValueDoc.canonical_name
epydoc.apidoc.VariableDoc.canonical_name" class="py-name" href="#" onclick="return doclink('link-158', 'canonical_name', 'link-73');">canonical_name</a></tt><tt class="py-op">[</tt><tt class="py-op">-</tt><tt class="py-number">1</tt><tt class="py-op">]</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt id="link-159" class="py-name"><a title="epydoc.checker._NO_PARAM" class="py-name" href="#" onclick="return doclink('link-159', '_NO_PARAM', 'link-6');">_NO_PARAM</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L331"></a><tt class="py-lineno">331</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-160" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_descrs=epydoc.apidoc.RoutineDoc-class.html#arg_descrs"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-160', 'arg_descrs', 'link-160');">arg_descrs</a></tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt id="link-161" class="py-name"><a title="epydoc.apidoc.UNKNOWN" class="py-name" href="#" onclick="return doclink('link-161', 'UNKNOWN', 'link-80');">UNKNOWN</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-162" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-162', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'No argument info'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt> <tt class="py-line"> <tt class="py-name">args_with_descr</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt id="link-163" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-163', 'arg', 'link-88');">arg</a></tt><tt class="py-op">,</tt> <tt id="link-164" class="py-name"><a title="epydoc.apidoc.APIDoc.descr
epydoc.cli.descr
epydoc.docwriter.html.HTMLWriter.descr
epydoc.markup.ParseError.descr
epydoc.markup.epytext.ColorizingError.descr" class="py-name" href="#" onclick="return doclink('link-164', 'descr', 'link-79');">descr</a></tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-165" class="py-name"><a title="epydoc.apidoc.RoutineDoc.arg_descrs" class="py-name" href="#" onclick="return doclink('link-165', 'arg_descrs', 'link-160');">arg_descrs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L336"></a><tt class="py-lineno">336</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">isinstance</tt><tt class="py-op">(</tt><tt id="link-166" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-166', 'arg', 'link-88');">arg</a></tt><tt class="py-op">,</tt> <tt class="py-name">basestring</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L337"></a><tt class="py-lineno">337</tt> <tt class="py-line"> <tt class="py-name">args_with_descr</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-167" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-167', 'arg', 'link-88');">arg</a></tt><tt class="py-op">)</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt> <tt class="py-line"> <tt class="py-name">args_with_descr</tt> <tt class="py-op">+=</tt> <tt id="link-168" class="py-name"><a title="epydoc.markup.Field.arg" class="py-name" href="#" onclick="return doclink('link-168', 'arg', 'link-88');">arg</a></tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">posarg</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-169" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.posargs=epydoc.apidoc.RoutineDoc-class.html#posargs"><a title="epydoc.apidoc.RoutineDoc.posargs" class="py-name" href="#" onclick="return doclink('link-169', 'posargs', 'link-169');">posargs</a></tt><tt class="py-op">:</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-170" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-170', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-171" class="py-name"><a title="epydoc.checker.DocChecker.DESCR" class="py-name" href="#" onclick="return doclink('link-171', 'DESCR', 'link-18');">DESCR</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L342"></a><tt class="py-lineno">342</tt> <tt class="py-line"> <tt class="py-name">posarg</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">args_with_descr</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L343"></a><tt class="py-lineno">343</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-172" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-172', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Argument(s) not described'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_checks</tt> <tt class="py-op">&</tt> <tt id="link-173" class="py-name"><a title="epydoc.checker.DocChecker" class="py-name" href="#" onclick="return doclink('link-173', 'DocChecker', 'link-25');">DocChecker</a></tt><tt class="py-op">.</tt><tt id="link-174" class="py-name"><a title="epydoc.checker.DocChecker.TYPE" class="py-name" href="#" onclick="return doclink('link-174', 'TYPE', 'link-15');">TYPE</a></tt> <tt class="py-keyword">and</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt> <tt class="py-line"> <tt class="py-name">posarg</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-name">doc</tt><tt class="py-op">.</tt><tt id="link-175" class="py-name" targets="Variable epydoc.apidoc.RoutineDoc.arg_types=epydoc.apidoc.RoutineDoc-class.html#arg_types"><a title="epydoc.apidoc.RoutineDoc.arg_types" class="py-name" href="#" onclick="return doclink('link-175', 'arg_types', 'link-175');">arg_types</a></tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-176" class="py-name"><a title="epydoc.checker.DocChecker.warning
epydoc.log.warning" class="py-name" href="#" onclick="return doclink('link-176', 'warning', 'link-40');">warning</a></tt><tt class="py-op">(</tt><tt class="py-string">'Argument type(s) not described'</tt><tt class="py-op">,</tt> <tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div><a name="L347"></a><tt class="py-lineno">347</tt> <tt class="py-line"> </tt>
<a name="DocChecker.warning"></a><div id="DocChecker.warning-def"><a name="L348"></a><tt class="py-lineno">348</tt> <a class="py-toggle" href="#" id="DocChecker.warning-toggle" onclick="return toggle('DocChecker.warning');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="epydoc.checker.DocChecker-class.html#warning">warning</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">doc</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="DocChecker.warning-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="DocChecker.warning-expanded"><a name="L349"></a><tt class="py-lineno">349</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">_warnings</tt><tt class="py-op">.</tt><tt class="py-name">setdefault</tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">,</tt><tt class="py-name">set</tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">add</tt><tt class="py-op">(</tt><tt class="py-name">doc</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L350"></a><tt class="py-lineno">350</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<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:09:52 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>
|
