Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html

eric7/Documentation/Source/eric7.DocumentationTools.ModuleDocumentor.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.DocumentationTools.ModuleDocumentor</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.DocumentationTools.ModuleDocumentor</h1>
24
25 <p>
26 Module implementing the builtin documentation generator.
27 </p>
28 <p>
29 The different parts of the module document are assembled from the parsed
30 Python file. The appearance is determined by several templates defined within
31 this module.
32 </p>
33 <h3>Global Attributes</h3>
34
35 <table>
36 <tr><td>_event</td></tr><tr><td>_signal</td></tr>
37 </table>
38 <h3>Classes</h3>
39
40 <table>
41
42 <tr>
43 <td><a href="#ModuleDocument">ModuleDocument</a></td>
44 <td>Class implementing the builtin documentation generator.</td>
45 </tr>
46 <tr>
47 <td><a href="#TagError">TagError</a></td>
48 <td>Exception class raised, if an invalid documentation tag was found.</td>
49 </tr>
50 </table>
51 <h3>Functions</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <hr />
57 <hr />
58 <a NAME="ModuleDocument" ID="ModuleDocument"></a>
59 <h2>ModuleDocument</h2>
60
61 <p>
62 Class implementing the builtin documentation generator.
63 </p>
64 <h3>Derived from</h3>
65 None
66 <h3>Class Attributes</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77
78 <table>
79
80 <tr>
81 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td>
82 <td>Constructor</td>
83 </tr>
84 <tr>
85 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td>
86 <td>Private method to check, if the object to be documented contains a deprecated flag.</td>
87 </tr>
88 <tr>
89 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td>
90 <td>Private method to format a cross reference entry.</td>
91 </tr>
92 <tr>
93 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td>
94 <td>Private method to format the contents of the documentation string.</td>
95 </tr>
96 <tr>
97 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td>
98 <td>Private method to generate the section listing all classes of the module.</td>
99 </tr>
100 <tr>
101 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td>
102 <td>Private method to generate the document section with details about classes.</td>
103 </tr>
104 <tr>
105 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td>
106 <td>Private method to generate the list section of a description.</td>
107 </tr>
108 <tr>
109 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td>
110 <td>Private method to generate the section listing all functions of the module.</td>
111 </tr>
112 <tr>
113 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td>
114 <td>Private method to generate the document section with details about functions.</td>
115 </tr>
116 <tr>
117 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td>
118 <td>Private method to generate the section listing all global attributes of the module.</td>
119 </tr>
120 <tr>
121 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td>
122 <td>Private method to generate a list section of the document.</td>
123 </tr>
124 <tr>
125 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td>
126 <td>Private method to generate the method details section.</td>
127 </tr>
128 <tr>
129 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td>
130 <td>Private method to generate the methods list section of a class.</td>
131 </tr>
132 <tr>
133 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td>
134 <td>Private method to generate the body of the document.</td>
135 </tr>
136 <tr>
137 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td>
138 <td>Private method to assemble the descriptive paragraphs of a docstring.</td>
139 </tr>
140 <tr>
141 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td>
142 <td>Private method to generate the list section of a description.</td>
143 </tr>
144 <tr>
145 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td>
146 <td>Private method to generate the classes list section of a Ruby module.</td>
147 </tr>
148 <tr>
149 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td>
150 <td>Private method to generate the Ruby module classes details section.</td>
151 </tr>
152 <tr>
153 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td>
154 <td>Private method to generate the section listing all modules of the file (Ruby only).</td>
155 </tr>
156 <tr>
157 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td>
158 <td>Private method to generate the document section with details about Ruby modules.</td>
159 </tr>
160 <tr>
161 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td>
162 <td>Private method to generate the "see also" list section of a description.</td>
163 </tr>
164 <tr>
165 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td>
166 <td>Private method to determine the short description of an object.</td>
167 </tr>
168 <tr>
169 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td>
170 <td>Private method to process inline tags.</td>
171 </tr>
172 <tr>
173 <td><a href="#ModuleDocument.description">description</a></td>
174 <td>Public method used to get the description of the module.</td>
175 </tr>
176 <tr>
177 <td><a href="#ModuleDocument.genDocument">genDocument</a></td>
178 <td>Public method to generate the source code documentation.</td>
179 </tr>
180 <tr>
181 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td>
182 <td>Public method to retrieve the parts for the QtHelp keywords section.</td>
183 </tr>
184 <tr>
185 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td>
186 <td>Public method to determine, if the module contains any classes or functions.</td>
187 </tr>
188 <tr>
189 <td><a href="#ModuleDocument.name">name</a></td>
190 <td>Public method used to get the module name.</td>
191 </tr>
192 <tr>
193 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td>
194 <td>Public method used to get the short description of the module.</td>
195 </tr>
196 </table>
197 <h3>Static Methods</h3>
198
199 <table>
200 <tr><td>None</td></tr>
201 </table>
202
203 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a>
204 <h4>ModuleDocument (Constructor)</h4>
205 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>)
206
207 <p>
208 Constructor
209 </p>
210 <dl>
211
212 <dt><i>module</i></dt>
213 <dd>
214 the information of the parsed Python file
215 </dd>
216 <dt><i>colors</i></dt>
217 <dd>
218 dictionary specifying the various colors for the output
219 (dictionary of strings)
220 </dd>
221 <dt><i>stylesheet</i></dt>
222 <dd>
223 the style to be used for the generated pages (string)
224 </dd>
225 </dl>
226 <a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a>
227 <h4>ModuleDocument.__checkDeprecated</h4>
228 <b>__checkDeprecated</b>(<i>descr</i>)
229
230 <p>
231 Private method to check, if the object to be documented contains a
232 deprecated flag.
233 </p>
234 <dl>
235
236 <dt><i>descr</i></dt>
237 <dd>
238 documentation string (string)
239 </dd>
240 </dl>
241 <dl>
242 <dt>Return:</dt>
243 <dd>
244 flag indicating the deprecation status (boolean)
245 </dd>
246 </dl>
247 <a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
248 <h4>ModuleDocument.__formatCrossReferenceEntry</h4>
249 <b>__formatCrossReferenceEntry</b>(<i>entry</i>)
250
251 <p>
252 Private method to format a cross reference entry.
253 </p>
254 <p>
255 This cross reference entry looks like "package.module#member label".
256 </p>
257 <dl>
258
259 <dt><i>entry</i></dt>
260 <dd>
261 the entry to be formatted (string)
262 </dd>
263 </dl>
264 <dl>
265 <dt>Return:</dt>
266 <dd>
267 formatted entry (string)
268 </dd>
269 </dl>
270 <a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
271 <h4>ModuleDocument.__formatDescription</h4>
272 <b>__formatDescription</b>(<i>descr</i>)
273
274 <p>
275 Private method to format the contents of the documentation string.
276 </p>
277 <dl>
278
279 <dt><i>descr</i></dt>
280 <dd>
281 The contents of the documentation string. (string)
282 </dd>
283 </dl>
284 <dl>
285 <dt>Return:</dt>
286 <dd>
287 The formatted contents of the documentation string. (string)
288 </dd>
289 </dl>
290 <dl>
291
292 <dt>Raises <b>TagError</b>:</dt>
293 <dd>
294 A tag doesn't have the correct number
295 of arguments.
296 </dd>
297 </dl>
298 <a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
299 <h4>ModuleDocument.__genClassListSection</h4>
300 <b>__genClassListSection</b>(<i></i>)
301
302 <p>
303 Private method to generate the section listing all classes of the
304 module.
305 </p>
306 <dl>
307 <dt>Return:</dt>
308 <dd>
309 The classes list section. (string)
310 </dd>
311 </dl>
312 <a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
313 <h4>ModuleDocument.__genClassesSection</h4>
314 <b>__genClassesSection</b>(<i></i>)
315
316 <p>
317 Private method to generate the document section with details about
318 classes.
319 </p>
320 <dl>
321 <dt>Return:</dt>
322 <dd>
323 The classes details section. (string)
324 </dd>
325 </dl>
326 <a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
327 <h4>ModuleDocument.__genDescriptionListSection</h4>
328 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>)
329
330 <p>
331 Private method to generate the list section of a description.
332 </p>
333 <dl>
334
335 <dt><i>dictionary</i></dt>
336 <dd>
337 Dictionary containing the info for the
338 list section.
339 </dd>
340 <dt><i>template</i></dt>
341 <dd>
342 The template to be used for the list. (string)
343 </dd>
344 </dl>
345 <dl>
346 <dt>Return:</dt>
347 <dd>
348 The list section. (string)
349 </dd>
350 </dl>
351 <a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
352 <h4>ModuleDocument.__genFunctionListSection</h4>
353 <b>__genFunctionListSection</b>(<i></i>)
354
355 <p>
356 Private method to generate the section listing all functions of the
357 module.
358 </p>
359 <dl>
360 <dt>Return:</dt>
361 <dd>
362 The functions list section. (string)
363 </dd>
364 </dl>
365 <a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
366 <h4>ModuleDocument.__genFunctionsSection</h4>
367 <b>__genFunctionsSection</b>(<i></i>)
368
369 <p>
370 Private method to generate the document section with details about
371 functions.
372 </p>
373 <dl>
374 <dt>Return:</dt>
375 <dd>
376 The functions details section. (string)
377 </dd>
378 </dl>
379 <a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
380 <h4>ModuleDocument.__genGlobalsListSection</h4>
381 <b>__genGlobalsListSection</b>(<i>class_=None</i>)
382
383 <p>
384 Private method to generate the section listing all global attributes of
385 the module.
386 </p>
387 <dl>
388
389 <dt><i>class_</i></dt>
390 <dd>
391 reference to a class object (Class)
392 </dd>
393 </dl>
394 <dl>
395 <dt>Return:</dt>
396 <dd>
397 The globals list section. (string)
398 </dd>
399 </dl>
400 <a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
401 <h4>ModuleDocument.__genListSection</h4>
402 <b>__genListSection</b>(<i>names, sectionDict, kwSuffix=""</i>)
403
404 <p>
405 Private method to generate a list section of the document.
406 </p>
407 <dl>
408
409 <dt><i>names</i></dt>
410 <dd>
411 The names to appear in the list. (list of strings)
412 </dd>
413 <dt><i>sectionDict</i></dt>
414 <dd>
415 dictionary containing all relevant information
416 (dict)
417 </dd>
418 <dt><i>kwSuffix</i></dt>
419 <dd>
420 suffix to be used for the QtHelp keywords (string)
421 </dd>
422 </dl>
423 <dl>
424 <dt>Return:</dt>
425 <dd>
426 list section (string)
427 </dd>
428 </dl>
429 <a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
430 <h4>ModuleDocument.__genMethodSection</h4>
431 <b>__genMethodSection</b>(<i>obj, className, modifierFilter</i>)
432
433 <p>
434 Private method to generate the method details section.
435 </p>
436 <dl>
437
438 <dt><i>obj</i></dt>
439 <dd>
440 reference to the object being formatted
441 </dd>
442 <dt><i>className</i></dt>
443 <dd>
444 name of the class containing the method (string)
445 </dd>
446 <dt><i>modifierFilter</i></dt>
447 <dd>
448 filter value designating the method types
449 </dd>
450 </dl>
451 <dl>
452 <dt>Return:</dt>
453 <dd>
454 method list and method details section (tuple of two string)
455 </dd>
456 </dl>
457 <a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
458 <h4>ModuleDocument.__genMethodsListSection</h4>
459 <b>__genMethodsListSection</b>(<i>names, sectionDict, className, clsName, includeInit=True</i>)
460
461 <p>
462 Private method to generate the methods list section of a class.
463 </p>
464 <dl>
465
466 <dt><i>names</i></dt>
467 <dd>
468 names to appear in the list (list of strings)
469 </dd>
470 <dt><i>sectionDict</i></dt>
471 <dd>
472 dictionary containing all relevant information
473 (dict)
474 </dd>
475 <dt><i>className</i></dt>
476 <dd>
477 class name containing the names
478 </dd>
479 <dt><i>clsName</i></dt>
480 <dd>
481 visible class name containing the names
482 </dd>
483 <dt><i>includeInit</i></dt>
484 <dd>
485 flag indicating to include the __init__ method
486 (boolean)
487 </dd>
488 </dl>
489 <dl>
490 <dt>Return:</dt>
491 <dd>
492 methods list section (string)
493 </dd>
494 </dl>
495 <a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
496 <h4>ModuleDocument.__genModuleSection</h4>
497 <b>__genModuleSection</b>(<i></i>)
498
499 <p>
500 Private method to generate the body of the document.
501 </p>
502 <dl>
503 <dt>Return:</dt>
504 <dd>
505 The body of the document. (string)
506 </dd>
507 </dl>
508 <a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
509 <h4>ModuleDocument.__genParagraphs</h4>
510 <b>__genParagraphs</b>(<i>lines</i>)
511
512 <p>
513 Private method to assemble the descriptive paragraphs of a docstring.
514 </p>
515 <p>
516 A paragraph is made up of a number of consecutive lines without
517 an intermediate empty line. Empty lines are treated as a paragraph
518 delimiter.
519 </p>
520 <dl>
521
522 <dt><i>lines</i></dt>
523 <dd>
524 A list of individual lines. (list of strings)
525 </dd>
526 </dl>
527 <dl>
528 <dt>Return:</dt>
529 <dd>
530 Ready formatted paragraphs. (string)
531 </dd>
532 </dl>
533 <a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
534 <h4>ModuleDocument.__genParamDescriptionListSection</h4>
535 <b>__genParamDescriptionListSection</b>(<i>_list</i>)
536
537 <p>
538 Private method to generate the list section of a description.
539 </p>
540 <dl>
541
542 <dt><i>_list</i></dt>
543 <dd>
544 list containing the info for the parameter description
545 list section (list of lists with three elements)
546 </dd>
547 </dl>
548 <dl>
549 <dt>Return:</dt>
550 <dd>
551 formatted list section (string)
552 </dd>
553 </dl>
554 <a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
555 <h4>ModuleDocument.__genRbModulesClassesListSection</h4>
556 <b>__genRbModulesClassesListSection</b>(<i>names, sectionDict, moduleName</i>)
557
558 <p>
559 Private method to generate the classes list section of a Ruby module.
560 </p>
561 <dl>
562
563 <dt><i>names</i></dt>
564 <dd>
565 The names to appear in the list. (list of strings)
566 </dd>
567 <dt><i>sectionDict</i></dt>
568 <dd>
569 dictionary containing all relevant information
570 (dict)
571 </dd>
572 <dt><i>moduleName</i></dt>
573 <dd>
574 name of the Ruby module containing the classes
575 (string)
576 </dd>
577 </dl>
578 <dl>
579 <dt>Return:</dt>
580 <dd>
581 The list section. (string)
582 </dd>
583 </dl>
584 <a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
585 <h4>ModuleDocument.__genRbModulesClassesSection</h4>
586 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>)
587
588 <p>
589 Private method to generate the Ruby module classes details section.
590 </p>
591 <dl>
592
593 <dt><i>obj</i></dt>
594 <dd>
595 Reference to the object being formatted.
596 </dd>
597 <dt><i>modName</i></dt>
598 <dd>
599 Name of the Ruby module containing the classes. (string)
600 </dd>
601 </dl>
602 <dl>
603 <dt>Return:</dt>
604 <dd>
605 The classes list and classes details section.
606 (tuple of two string)
607 </dd>
608 </dl>
609 <a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
610 <h4>ModuleDocument.__genRbModulesListSection</h4>
611 <b>__genRbModulesListSection</b>(<i></i>)
612
613 <p>
614 Private method to generate the section listing all modules of the file
615 (Ruby only).
616 </p>
617 <dl>
618 <dt>Return:</dt>
619 <dd>
620 The modules list section. (string)
621 </dd>
622 </dl>
623 <a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
624 <h4>ModuleDocument.__genRbModulesSection</h4>
625 <b>__genRbModulesSection</b>(<i></i>)
626
627 <p>
628 Private method to generate the document section with details about
629 Ruby modules.
630 </p>
631 <dl>
632 <dt>Return:</dt>
633 <dd>
634 The Ruby modules details section. (string)
635 </dd>
636 </dl>
637 <a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
638 <h4>ModuleDocument.__genSeeListSection</h4>
639 <b>__genSeeListSection</b>(<i>_list, template</i>)
640
641 <p>
642 Private method to generate the "see also" list section of a
643 description.
644 </p>
645 <dl>
646
647 <dt><i>_list</i></dt>
648 <dd>
649 List containing the info for the section.
650 </dd>
651 <dt><i>template</i></dt>
652 <dd>
653 The template to be used for the list. (string)
654 </dd>
655 </dl>
656 <dl>
657 <dt>Return:</dt>
658 <dd>
659 The list section. (string)
660 </dd>
661 </dl>
662 <a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
663 <h4>ModuleDocument.__getShortDescription</h4>
664 <b>__getShortDescription</b>(<i>desc</i>)
665
666 <p>
667 Private method to determine the short description of an object.
668 </p>
669 <p>
670 The short description is just the first non empty line of the
671 documentation string.
672 </p>
673 <dl>
674
675 <dt><i>desc</i></dt>
676 <dd>
677 The documentation string. (string)
678 </dd>
679 </dl>
680 <dl>
681 <dt>Return:</dt>
682 <dd>
683 The short description. (string)
684 </dd>
685 </dl>
686 <a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
687 <h4>ModuleDocument.__processInlineTags</h4>
688 <b>__processInlineTags</b>(<i>desc</i>)
689
690 <p>
691 Private method to process inline tags.
692 </p>
693 <dl>
694
695 <dt><i>desc</i></dt>
696 <dd>
697 One line of the description (string)
698 </dd>
699 </dl>
700 <dl>
701 <dt>Return:</dt>
702 <dd>
703 processed line with inline tags expanded (string)
704 </dd>
705 </dl>
706 <dl>
707
708 <dt>Raises <b>TagError</b>:</dt>
709 <dd>
710 raised to indicate an invalid tag
711 </dd>
712 </dl>
713 <a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
714 <h4>ModuleDocument.description</h4>
715 <b>description</b>(<i></i>)
716
717 <p>
718 Public method used to get the description of the module.
719 </p>
720 <dl>
721 <dt>Return:</dt>
722 <dd>
723 The description of the module. (string)
724 </dd>
725 </dl>
726 <a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
727 <h4>ModuleDocument.genDocument</h4>
728 <b>genDocument</b>(<i></i>)
729
730 <p>
731 Public method to generate the source code documentation.
732 </p>
733 <dl>
734 <dt>Return:</dt>
735 <dd>
736 The source code documentation. (string)
737 </dd>
738 </dl>
739 <a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
740 <h4>ModuleDocument.getQtHelpKeywords</h4>
741 <b>getQtHelpKeywords</b>(<i></i>)
742
743 <p>
744 Public method to retrieve the parts for the QtHelp keywords section.
745 </p>
746 <dl>
747 <dt>Return:</dt>
748 <dd>
749 list of tuples containing the name (string) and the ref
750 (string). The ref is without the filename part.
751 </dd>
752 </dl>
753 <a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
754 <h4>ModuleDocument.isEmpty</h4>
755 <b>isEmpty</b>(<i></i>)
756
757 <p>
758 Public method to determine, if the module contains any classes or
759 functions.
760 </p>
761 <dl>
762 <dt>Return:</dt>
763 <dd>
764 Flag indicating an empty module (i.e. __init__.py without
765 any contents)
766 </dd>
767 </dl>
768 <a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
769 <h4>ModuleDocument.name</h4>
770 <b>name</b>(<i></i>)
771
772 <p>
773 Public method used to get the module name.
774 </p>
775 <dl>
776 <dt>Return:</dt>
777 <dd>
778 The name of the module. (string)
779 </dd>
780 </dl>
781 <a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
782 <h4>ModuleDocument.shortDescription</h4>
783 <b>shortDescription</b>(<i></i>)
784
785 <p>
786 Public method used to get the short description of the module.
787 </p>
788 <p>
789 The short description is just the first line of the modules
790 description.
791 </p>
792 <dl>
793 <dt>Return:</dt>
794 <dd>
795 The short description of the module. (string)
796 </dd>
797 </dl>
798 <div align="right"><a href="#top">Up</a></div>
799 <hr />
800 <hr />
801 <a NAME="TagError" ID="TagError"></a>
802 <h2>TagError</h2>
803
804 <p>
805 Exception class raised, if an invalid documentation tag was found.
806 </p>
807 <h3>Derived from</h3>
808 Exception
809 <h3>Class Attributes</h3>
810
811 <table>
812 <tr><td>None</td></tr>
813 </table>
814 <h3>Class Methods</h3>
815
816 <table>
817 <tr><td>None</td></tr>
818 </table>
819 <h3>Methods</h3>
820
821 <table>
822 <tr><td>None</td></tr>
823 </table>
824 <h3>Static Methods</h3>
825
826 <table>
827 <tr><td>None</td></tr>
828 </table>
829
830 <div align="right"><a href="#top">Up</a></div>
831 <hr />
832 </body></html>

Mercurial Repository: eric

eric ide

mercurial