Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.DocumentationTools.ModuleDocumentor.html

changeset 3673
e26d7d0c1088
child 4267
94496d77156b
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.DocumentationTools.ModuleDocumentor</h1>
23 <p>
24 Module implementing the builtin documentation generator.
25 </p><p>
26 The different parts of the module document are assembled from the parsed
27 Python file. The appearance is determined by several templates defined within
28 this module.
29 </p>
30 <h3>Global Attributes</h3>
31 <table>
32 <tr><td>_event</td></tr><tr><td>_signal</td></tr>
33 </table>
34 <h3>Classes</h3>
35 <table>
36 <tr>
37 <td><a href="#ModuleDocument">ModuleDocument</a></td>
38 <td>Class implementing the builtin documentation generator.</td>
39 </tr><tr>
40 <td><a href="#TagError">TagError</a></td>
41 <td>Exception class raised, if an invalid documentation tag was found.</td>
42 </tr>
43 </table>
44 <h3>Functions</h3>
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr /><hr />
49 <a NAME="ModuleDocument" ID="ModuleDocument"></a>
50 <h2>ModuleDocument</h2>
51 <p>
52 Class implementing the builtin documentation generator.
53 </p>
54 <h3>Derived from</h3>
55 object
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td>
71 <td>Private method to check, if the object to be documented contains a deprecated flag.</td>
72 </tr><tr>
73 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td>
74 <td>Private method to format a cross reference entry.</td>
75 </tr><tr>
76 <td><a href="#ModuleDocument.__formatDescription">__formatDescription</a></td>
77 <td>Private method to format the contents of the documentation string.</td>
78 </tr><tr>
79 <td><a href="#ModuleDocument.__genClassListSection">__genClassListSection</a></td>
80 <td>Private method to generate the section listing all classes of the module.</td>
81 </tr><tr>
82 <td><a href="#ModuleDocument.__genClassesSection">__genClassesSection</a></td>
83 <td>Private method to generate the document section with details about classes.</td>
84 </tr><tr>
85 <td><a href="#ModuleDocument.__genDescriptionListSection">__genDescriptionListSection</a></td>
86 <td>Private method to generate the list section of a description.</td>
87 </tr><tr>
88 <td><a href="#ModuleDocument.__genFunctionListSection">__genFunctionListSection</a></td>
89 <td>Private method to generate the section listing all functions of the module.</td>
90 </tr><tr>
91 <td><a href="#ModuleDocument.__genFunctionsSection">__genFunctionsSection</a></td>
92 <td>Private method to generate the document section with details about functions.</td>
93 </tr><tr>
94 <td><a href="#ModuleDocument.__genGlobalsListSection">__genGlobalsListSection</a></td>
95 <td>Private method to generate the section listing all global attributes of the module.</td>
96 </tr><tr>
97 <td><a href="#ModuleDocument.__genListSection">__genListSection</a></td>
98 <td>Private method to generate a list section of the document.</td>
99 </tr><tr>
100 <td><a href="#ModuleDocument.__genMethodSection">__genMethodSection</a></td>
101 <td>Private method to generate the method details section.</td>
102 </tr><tr>
103 <td><a href="#ModuleDocument.__genMethodsListSection">__genMethodsListSection</a></td>
104 <td>Private method to generate the methods list section of a class.</td>
105 </tr><tr>
106 <td><a href="#ModuleDocument.__genModuleSection">__genModuleSection</a></td>
107 <td>Private method to generate the body of the document.</td>
108 </tr><tr>
109 <td><a href="#ModuleDocument.__genParagraphs">__genParagraphs</a></td>
110 <td>Private method to assemble the descriptive paragraphs of a docstring.</td>
111 </tr><tr>
112 <td><a href="#ModuleDocument.__genParamDescriptionListSection">__genParamDescriptionListSection</a></td>
113 <td>Private method to generate the list section of a description.</td>
114 </tr><tr>
115 <td><a href="#ModuleDocument.__genRbModulesClassesListSection">__genRbModulesClassesListSection</a></td>
116 <td>Private method to generate the classes list section of a Ruby module.</td>
117 </tr><tr>
118 <td><a href="#ModuleDocument.__genRbModulesClassesSection">__genRbModulesClassesSection</a></td>
119 <td>Private method to generate the Ruby module classes details section.</td>
120 </tr><tr>
121 <td><a href="#ModuleDocument.__genRbModulesListSection">__genRbModulesListSection</a></td>
122 <td>Private method to generate the section listing all modules of the file (Ruby only).</td>
123 </tr><tr>
124 <td><a href="#ModuleDocument.__genRbModulesSection">__genRbModulesSection</a></td>
125 <td>Private method to generate the document section with details about Ruby modules.</td>
126 </tr><tr>
127 <td><a href="#ModuleDocument.__genSeeListSection">__genSeeListSection</a></td>
128 <td>Private method to generate the "see also" list section of a description.</td>
129 </tr><tr>
130 <td><a href="#ModuleDocument.__getShortDescription">__getShortDescription</a></td>
131 <td>Private method to determine the short description of an object.</td>
132 </tr><tr>
133 <td><a href="#ModuleDocument.__processInlineTags">__processInlineTags</a></td>
134 <td>Private method to process inline tags.</td>
135 </tr><tr>
136 <td><a href="#ModuleDocument.description">description</a></td>
137 <td>Public method used to get the description of the module.</td>
138 </tr><tr>
139 <td><a href="#ModuleDocument.genDocument">genDocument</a></td>
140 <td>Public method to generate the source code documentation.</td>
141 </tr><tr>
142 <td><a href="#ModuleDocument.getQtHelpKeywords">getQtHelpKeywords</a></td>
143 <td>Public method to retrieve the parts for the QtHelp keywords section.</td>
144 </tr><tr>
145 <td><a href="#ModuleDocument.isEmpty">isEmpty</a></td>
146 <td>Public method to determine, if the module contains any classes or functions.</td>
147 </tr><tr>
148 <td><a href="#ModuleDocument.name">name</a></td>
149 <td>Public method used to get the module name.</td>
150 </tr><tr>
151 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td>
152 <td>Public method used to get the short description of the module.</td>
153 </tr>
154 </table>
155 <h3>Static Methods</h3>
156 <table>
157 <tr><td>None</td></tr>
158 </table>
159 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a>
160 <h4>ModuleDocument (Constructor)</h4>
161 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>)
162 <p>
163 Constructor
164 </p><dl>
165 <dt><i>module</i></dt>
166 <dd>
167 the information of the parsed Python file
168 </dd><dt><i>colors</i></dt>
169 <dd>
170 dictionary specifying the various colors for the output
171 (dictionary of strings)
172 </dd><dt><i>stylesheet</i></dt>
173 <dd>
174 the style to be used for the generated pages (string)
175 </dd>
176 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a>
177 <h4>ModuleDocument.__checkDeprecated</h4>
178 <b>__checkDeprecated</b>(<i>descr</i>)
179 <p>
180 Private method to check, if the object to be documented contains a
181 deprecated flag.
182 </p><dl>
183 <dt><i>descr</i></dt>
184 <dd>
185 documentation string (string)
186 </dd>
187 </dl><dl>
188 <dt>Returns:</dt>
189 <dd>
190 flag indicating the deprecation status (boolean)
191 </dd>
192 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a>
193 <h4>ModuleDocument.__formatCrossReferenceEntry</h4>
194 <b>__formatCrossReferenceEntry</b>(<i>entry</i>)
195 <p>
196 Private method to format a cross reference entry.
197 </p><p>
198 This cross reference entry looks like "package.module#member label".
199 </p><dl>
200 <dt><i>entry</i></dt>
201 <dd>
202 the entry to be formatted (string)
203 </dd>
204 </dl><dl>
205 <dt>Returns:</dt>
206 <dd>
207 formatted entry (string)
208 </dd>
209 </dl><a NAME="ModuleDocument.__formatDescription" ID="ModuleDocument.__formatDescription"></a>
210 <h4>ModuleDocument.__formatDescription</h4>
211 <b>__formatDescription</b>(<i>descr</i>)
212 <p>
213 Private method to format the contents of the documentation string.
214 </p><dl>
215 <dt><i>descr</i></dt>
216 <dd>
217 The contents of the documentation string. (string)
218 </dd>
219 </dl><dl>
220 <dt>Returns:</dt>
221 <dd>
222 The formated contents of the documentation string. (string)
223 </dd>
224 </dl><dl>
225 <dt>Raises <b>TagError</b>:</dt>
226 <dd>
227 A tag doesn't have the correct number
228 of arguments.
229 </dd>
230 </dl><a NAME="ModuleDocument.__genClassListSection" ID="ModuleDocument.__genClassListSection"></a>
231 <h4>ModuleDocument.__genClassListSection</h4>
232 <b>__genClassListSection</b>(<i></i>)
233 <p>
234 Private method to generate the section listing all classes of the
235 module.
236 </p><dl>
237 <dt>Returns:</dt>
238 <dd>
239 The classes list section. (string)
240 </dd>
241 </dl><a NAME="ModuleDocument.__genClassesSection" ID="ModuleDocument.__genClassesSection"></a>
242 <h4>ModuleDocument.__genClassesSection</h4>
243 <b>__genClassesSection</b>(<i></i>)
244 <p>
245 Private method to generate the document section with details about
246 classes.
247 </p><dl>
248 <dt>Returns:</dt>
249 <dd>
250 The classes details section. (string)
251 </dd>
252 </dl><a NAME="ModuleDocument.__genDescriptionListSection" ID="ModuleDocument.__genDescriptionListSection"></a>
253 <h4>ModuleDocument.__genDescriptionListSection</h4>
254 <b>__genDescriptionListSection</b>(<i>dictionary, template</i>)
255 <p>
256 Private method to generate the list section of a description.
257 </p><dl>
258 <dt><i>dictionary</i></dt>
259 <dd>
260 Dictionary containing the info for the
261 list section.
262 </dd><dt><i>template</i></dt>
263 <dd>
264 The template to be used for the list. (string)
265 </dd>
266 </dl><dl>
267 <dt>Returns:</dt>
268 <dd>
269 The list section. (string)
270 </dd>
271 </dl><a NAME="ModuleDocument.__genFunctionListSection" ID="ModuleDocument.__genFunctionListSection"></a>
272 <h4>ModuleDocument.__genFunctionListSection</h4>
273 <b>__genFunctionListSection</b>(<i></i>)
274 <p>
275 Private method to generate the section listing all functions of the
276 module.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 The functions list section. (string)
281 </dd>
282 </dl><a NAME="ModuleDocument.__genFunctionsSection" ID="ModuleDocument.__genFunctionsSection"></a>
283 <h4>ModuleDocument.__genFunctionsSection</h4>
284 <b>__genFunctionsSection</b>(<i></i>)
285 <p>
286 Private method to generate the document section with details about
287 functions.
288 </p><dl>
289 <dt>Returns:</dt>
290 <dd>
291 The functions details section. (string)
292 </dd>
293 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a>
294 <h4>ModuleDocument.__genGlobalsListSection</h4>
295 <b>__genGlobalsListSection</b>(<i>class_=None</i>)
296 <p>
297 Private method to generate the section listing all global attributes of
298 the module.
299 </p><dl>
300 <dt><i>class_</i></dt>
301 <dd>
302 reference to a class object (Class)
303 </dd>
304 </dl><dl>
305 <dt>Returns:</dt>
306 <dd>
307 The globals list section. (string)
308 </dd>
309 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a>
310 <h4>ModuleDocument.__genListSection</h4>
311 <b>__genListSection</b>(<i>names, dict, kwSuffix=""</i>)
312 <p>
313 Private method to generate a list section of the document.
314 </p><dl>
315 <dt><i>names</i></dt>
316 <dd>
317 The names to appear in the list. (list of strings)
318 </dd><dt><i>dict</i></dt>
319 <dd>
320 A dictionary containing all relevant information.
321 </dd><dt><i>kwSuffix</i></dt>
322 <dd>
323 suffix to be used for the QtHelp keywords (string)
324 </dd>
325 </dl><dl>
326 <dt>Returns:</dt>
327 <dd>
328 The list section. (string)
329 </dd>
330 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a>
331 <h4>ModuleDocument.__genMethodSection</h4>
332 <b>__genMethodSection</b>(<i>obj, className, filter</i>)
333 <p>
334 Private method to generate the method details section.
335 </p><dl>
336 <dt><i>obj</i></dt>
337 <dd>
338 reference to the object being formatted
339 </dd><dt><i>className</i></dt>
340 <dd>
341 name of the class containing the method (string)
342 </dd><dt><i>filter</i></dt>
343 <dd>
344 filter value designating the method types
345 </dd>
346 </dl><dl>
347 <dt>Returns:</dt>
348 <dd>
349 method list and method details section (tuple of two string)
350 </dd>
351 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a>
352 <h4>ModuleDocument.__genMethodsListSection</h4>
353 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName, includeInit=True</i>)
354 <p>
355 Private method to generate the methods list section of a class.
356 </p><dl>
357 <dt><i>names</i></dt>
358 <dd>
359 names to appear in the list (list of strings)
360 </dd><dt><i>dict</i></dt>
361 <dd>
362 dictionary containing all relevant information
363 </dd><dt><i>className</i></dt>
364 <dd>
365 class name containing the names
366 </dd><dt><i>clsName</i></dt>
367 <dd>
368 visible class name containing the names
369 </dd><dt><i>includeInit</i></dt>
370 <dd>
371 flag indicating to include the __init__ method
372 (boolean)
373 </dd>
374 </dl><dl>
375 <dt>Returns:</dt>
376 <dd>
377 methods list section (string)
378 </dd>
379 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a>
380 <h4>ModuleDocument.__genModuleSection</h4>
381 <b>__genModuleSection</b>(<i></i>)
382 <p>
383 Private method to generate the body of the document.
384 </p><dl>
385 <dt>Returns:</dt>
386 <dd>
387 The body of the document. (string)
388 </dd>
389 </dl><a NAME="ModuleDocument.__genParagraphs" ID="ModuleDocument.__genParagraphs"></a>
390 <h4>ModuleDocument.__genParagraphs</h4>
391 <b>__genParagraphs</b>(<i>lines</i>)
392 <p>
393 Private method to assemble the descriptive paragraphs of a docstring.
394 </p><p>
395 A paragraph is made up of a number of consecutive lines without
396 an intermediate empty line. Empty lines are treated as a paragraph
397 delimiter.
398 </p><dl>
399 <dt><i>lines</i></dt>
400 <dd>
401 A list of individual lines. (list of strings)
402 </dd>
403 </dl><dl>
404 <dt>Returns:</dt>
405 <dd>
406 Ready formatted paragraphs. (string)
407 </dd>
408 </dl><a NAME="ModuleDocument.__genParamDescriptionListSection" ID="ModuleDocument.__genParamDescriptionListSection"></a>
409 <h4>ModuleDocument.__genParamDescriptionListSection</h4>
410 <b>__genParamDescriptionListSection</b>(<i>_list, template</i>)
411 <p>
412 Private method to generate the list section of a description.
413 </p><dl>
414 <dt><i>_list</i></dt>
415 <dd>
416 List containing the info for the
417 list section.
418 </dd><dt><i>template</i></dt>
419 <dd>
420 The template to be used for the list. (string)
421 </dd>
422 </dl><dl>
423 <dt>Returns:</dt>
424 <dd>
425 The list section. (string)
426 </dd>
427 </dl><a NAME="ModuleDocument.__genRbModulesClassesListSection" ID="ModuleDocument.__genRbModulesClassesListSection"></a>
428 <h4>ModuleDocument.__genRbModulesClassesListSection</h4>
429 <b>__genRbModulesClassesListSection</b>(<i>names, dict, moduleName</i>)
430 <p>
431 Private method to generate the classes list section of a Ruby module.
432 </p><dl>
433 <dt><i>names</i></dt>
434 <dd>
435 The names to appear in the list. (list of strings)
436 </dd><dt><i>dict</i></dt>
437 <dd>
438 A dictionary containing all relevant information.
439 </dd><dt><i>moduleName</i></dt>
440 <dd>
441 Name of the Ruby module containing the classes.
442 (string)
443 </dd>
444 </dl><dl>
445 <dt>Returns:</dt>
446 <dd>
447 The list section. (string)
448 </dd>
449 </dl><a NAME="ModuleDocument.__genRbModulesClassesSection" ID="ModuleDocument.__genRbModulesClassesSection"></a>
450 <h4>ModuleDocument.__genRbModulesClassesSection</h4>
451 <b>__genRbModulesClassesSection</b>(<i>obj, modName</i>)
452 <p>
453 Private method to generate the Ruby module classes details section.
454 </p><dl>
455 <dt><i>obj</i></dt>
456 <dd>
457 Reference to the object being formatted.
458 </dd><dt><i>modName</i></dt>
459 <dd>
460 Name of the Ruby module containing the classes. (string)
461 </dd>
462 </dl><dl>
463 <dt>Returns:</dt>
464 <dd>
465 The classes list and classes details section.
466 (tuple of two string)
467 </dd>
468 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a>
469 <h4>ModuleDocument.__genRbModulesListSection</h4>
470 <b>__genRbModulesListSection</b>(<i></i>)
471 <p>
472 Private method to generate the section listing all modules of the file
473 (Ruby only).
474 </p><dl>
475 <dt>Returns:</dt>
476 <dd>
477 The modules list section. (string)
478 </dd>
479 </dl><a NAME="ModuleDocument.__genRbModulesSection" ID="ModuleDocument.__genRbModulesSection"></a>
480 <h4>ModuleDocument.__genRbModulesSection</h4>
481 <b>__genRbModulesSection</b>(<i></i>)
482 <p>
483 Private method to generate the document section with details about
484 Ruby modules.
485 </p><dl>
486 <dt>Returns:</dt>
487 <dd>
488 The Ruby modules details section. (string)
489 </dd>
490 </dl><a NAME="ModuleDocument.__genSeeListSection" ID="ModuleDocument.__genSeeListSection"></a>
491 <h4>ModuleDocument.__genSeeListSection</h4>
492 <b>__genSeeListSection</b>(<i>_list, template</i>)
493 <p>
494 Private method to generate the "see also" list section of a
495 description.
496 </p><dl>
497 <dt><i>_list</i></dt>
498 <dd>
499 List containing the info for the section.
500 </dd><dt><i>template</i></dt>
501 <dd>
502 The template to be used for the list. (string)
503 </dd>
504 </dl><dl>
505 <dt>Returns:</dt>
506 <dd>
507 The list section. (string)
508 </dd>
509 </dl><a NAME="ModuleDocument.__getShortDescription" ID="ModuleDocument.__getShortDescription"></a>
510 <h4>ModuleDocument.__getShortDescription</h4>
511 <b>__getShortDescription</b>(<i>desc</i>)
512 <p>
513 Private method to determine the short description of an object.
514 </p><p>
515 The short description is just the first non empty line of the
516 documentation string.
517 </p><dl>
518 <dt><i>desc</i></dt>
519 <dd>
520 The documentation string. (string)
521 </dd>
522 </dl><dl>
523 <dt>Returns:</dt>
524 <dd>
525 The short description. (string)
526 </dd>
527 </dl><a NAME="ModuleDocument.__processInlineTags" ID="ModuleDocument.__processInlineTags"></a>
528 <h4>ModuleDocument.__processInlineTags</h4>
529 <b>__processInlineTags</b>(<i>desc</i>)
530 <p>
531 Private method to process inline tags.
532 </p><dl>
533 <dt><i>desc</i></dt>
534 <dd>
535 One line of the description (string)
536 </dd>
537 </dl><dl>
538 <dt>Returns:</dt>
539 <dd>
540 processed line with inline tags expanded (string)
541 </dd>
542 </dl><dl>
543 <dt>Raises <b>TagError</b>:</dt>
544 <dd>
545 raised to indicate an invalid tag
546 </dd>
547 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a>
548 <h4>ModuleDocument.description</h4>
549 <b>description</b>(<i></i>)
550 <p>
551 Public method used to get the description of the module.
552 </p><dl>
553 <dt>Returns:</dt>
554 <dd>
555 The description of the module. (string)
556 </dd>
557 </dl><a NAME="ModuleDocument.genDocument" ID="ModuleDocument.genDocument"></a>
558 <h4>ModuleDocument.genDocument</h4>
559 <b>genDocument</b>(<i></i>)
560 <p>
561 Public method to generate the source code documentation.
562 </p><dl>
563 <dt>Returns:</dt>
564 <dd>
565 The source code documentation. (string)
566 </dd>
567 </dl><a NAME="ModuleDocument.getQtHelpKeywords" ID="ModuleDocument.getQtHelpKeywords"></a>
568 <h4>ModuleDocument.getQtHelpKeywords</h4>
569 <b>getQtHelpKeywords</b>(<i></i>)
570 <p>
571 Public method to retrieve the parts for the QtHelp keywords section.
572 </p><dl>
573 <dt>Returns:</dt>
574 <dd>
575 list of tuples containing the name (string) and the ref
576 (string). The ref is without the filename part.
577 </dd>
578 </dl><a NAME="ModuleDocument.isEmpty" ID="ModuleDocument.isEmpty"></a>
579 <h4>ModuleDocument.isEmpty</h4>
580 <b>isEmpty</b>(<i></i>)
581 <p>
582 Public method to determine, if the module contains any classes or
583 functions.
584 </p><dl>
585 <dt>Returns:</dt>
586 <dd>
587 Flag indicating an empty module (i.e. __init__.py without
588 any contents)
589 </dd>
590 </dl><a NAME="ModuleDocument.name" ID="ModuleDocument.name"></a>
591 <h4>ModuleDocument.name</h4>
592 <b>name</b>(<i></i>)
593 <p>
594 Public method used to get the module name.
595 </p><dl>
596 <dt>Returns:</dt>
597 <dd>
598 The name of the module. (string)
599 </dd>
600 </dl><a NAME="ModuleDocument.shortDescription" ID="ModuleDocument.shortDescription"></a>
601 <h4>ModuleDocument.shortDescription</h4>
602 <b>shortDescription</b>(<i></i>)
603 <p>
604 Public method used to get the short description of the module.
605 </p><p>
606 The short description is just the first line of the modules
607 description.
608 </p><dl>
609 <dt>Returns:</dt>
610 <dd>
611 The short description of the module. (string)
612 </dd>
613 </dl>
614 <div align="right"><a href="#top">Up</a></div>
615 <hr /><hr />
616 <a NAME="TagError" ID="TagError"></a>
617 <h2>TagError</h2>
618 <p>
619 Exception class raised, if an invalid documentation tag was found.
620 </p>
621 <h3>Derived from</h3>
622 Exception
623 <h3>Class Attributes</h3>
624 <table>
625 <tr><td>None</td></tr>
626 </table>
627 <h3>Class Methods</h3>
628 <table>
629 <tr><td>None</td></tr>
630 </table>
631 <h3>Methods</h3>
632 <table>
633 <tr><td>None</td></tr>
634 </table>
635 <h3>Static Methods</h3>
636 <table>
637 <tr><td>None</td></tr>
638 </table>
639
640 <div align="right"><a href="#top">Up</a></div>
641 <hr />
642 </body></html>

Mercurial Repository: eric

eric ide

mercurial