Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
- changeset 1228
- 7afaf2fca55b
- parent 945
- 8cd4d08fa9f6
- child 1229
- a8207dc73672
equal
deleted
inserted
replaced
| 1227:c5db073a124f | 1228:7afaf2fca55b |
|---|---|
| 56 object | 56 object |
| 57 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 <table> | 58 <table> |
| 59 <tr><td>None</td></tr> | 59 <tr><td>None</td></tr> |
| 60 </table> | 60 </table> |
| 61 <h3>Class Methods</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 61 <h3>Methods</h3> | 65 <h3>Methods</h3> |
| 62 <table> | 66 <table> |
| 63 <tr> | 67 <tr> |
| 64 <td><a href="#ModuleDocument.__init__">ModuleDocument</a></td> | |
| 65 <td>Constructor</td> | |
| 66 </tr><tr> | |
| 67 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td> | 68 <td><a href="#ModuleDocument.__checkDeprecated">__checkDeprecated</a></td> |
| 68 <td>Private method to check, if the object to be documented contains a deprecated flag.</td> | 69 <td>Private method to check, if the object to be documented contains a deprecated flag.</td> |
| 69 </tr><tr> | 70 </tr><tr> |
| 70 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td> | 71 <td><a href="#ModuleDocument.__formatCrossReferenceEntry">__formatCrossReferenceEntry</a></td> |
| 71 <td>Private method to format a cross reference entry.</td> | 72 <td>Private method to format a cross reference entry.</td> |
| 147 </tr><tr> | 148 </tr><tr> |
| 148 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> | 149 <td><a href="#ModuleDocument.shortDescription">shortDescription</a></td> |
| 149 <td>Public method used to get the short description of the module.</td> | 150 <td>Public method used to get the short description of the module.</td> |
| 150 </tr> | 151 </tr> |
| 151 </table> | 152 </table> |
| 153 <h3>Static Methods</h3> | |
| 154 <table> | |
| 155 <tr><td>None</td></tr> | |
| 156 </table> | |
| 152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> | 157 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> |
| 153 <h4>ModuleDocument (Constructor)</h4> | 158 <h4>ModuleDocument (Constructor)</h4> |
| 154 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>) | 159 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>) |
| 155 <p> | 160 <p> |
| 156 Constructor | 161 Constructor |
| 316 <dd> | 321 <dd> |
| 317 The list section. (string) | 322 The list section. (string) |
| 318 </dd> | 323 </dd> |
| 319 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> | 324 </dl><a NAME="ModuleDocument.__genMethodSection" ID="ModuleDocument.__genMethodSection"></a> |
| 320 <h4>ModuleDocument.__genMethodSection</h4> | 325 <h4>ModuleDocument.__genMethodSection</h4> |
| 321 <b>__genMethodSection</b>(<i>obj, className</i>) | 326 <b>__genMethodSection</b>(<i>obj, className, filter</i>) |
| 322 <p> | 327 <p> |
| 323 Private method to generate the method details section. | 328 Private method to generate the method details section. |
| 324 </p><dl> | 329 </p><dl> |
| 325 <dt><i>obj</i></dt> | 330 <dt><i>obj</i></dt> |
| 326 <dd> | 331 <dd> |
| 327 Reference to the object being formatted. | 332 reference to the object being formatted |
| 328 </dd><dt><i>className</i></dt> | 333 </dd><dt><i>className</i></dt> |
| 329 <dd> | 334 <dd> |
| 330 Name of the class containing the method. (string) | 335 name of the class containing the method (string) |
| 331 </dd> | 336 </dd><dt><i>filter</i></dt> |
| 332 </dl><dl> | 337 <dd> |
| 333 <dt>Returns:</dt> | 338 filter value designating the method types |
| 334 <dd> | 339 </dd> |
| 335 The method list and method details section. (tuple of two string) | 340 </dl><dl> |
| 341 <dt>Returns:</dt> | |
| 342 <dd> | |
| 343 method list and method details section (tuple of two string) | |
| 336 </dd> | 344 </dd> |
| 337 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> | 345 </dl><a NAME="ModuleDocument.__genMethodsListSection" ID="ModuleDocument.__genMethodsListSection"></a> |
| 338 <h4>ModuleDocument.__genMethodsListSection</h4> | 346 <h4>ModuleDocument.__genMethodsListSection</h4> |
| 339 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName</i>) | 347 <b>__genMethodsListSection</b>(<i>names, dict, className, clsName, includeInit=True</i>) |
| 340 <p> | 348 <p> |
| 341 Private method to generate the methods list section of a class. | 349 Private method to generate the methods list section of a class. |
| 342 </p><dl> | 350 </p><dl> |
| 343 <dt><i>names</i></dt> | 351 <dt><i>names</i></dt> |
| 344 <dd> | 352 <dd> |
| 345 The names to appear in the list. (list of strings) | 353 names to appear in the list (list of strings) |
| 346 </dd><dt><i>dict</i></dt> | 354 </dd><dt><i>dict</i></dt> |
| 347 <dd> | 355 <dd> |
| 348 A dictionary containing all relevant information. | 356 dictionary containing all relevant information |
| 349 </dd><dt><i>className</i></dt> | 357 </dd><dt><i>className</i></dt> |
| 350 <dd> | 358 <dd> |
| 351 The class name containing the names. | 359 class name containing the names |
| 352 </dd><dt><i>clsName</i></dt> | 360 </dd><dt><i>clsName</i></dt> |
| 353 <dd> | 361 <dd> |
| 354 The visible class name containing the names. | 362 visible class name containing the names |
| 355 </dd> | 363 </dd><dt><i>includeInit</i></dt> |
| 356 </dl><dl> | 364 <dd> |
| 357 <dt>Returns:</dt> | 365 flag indicating to include the __init__ method (boolean) |
| 358 <dd> | 366 </dd> |
| 359 The list section. (string) | 367 </dl><dl> |
| 368 <dt>Returns:</dt> | |
| 369 <dd> | |
| 370 methods list section (string) | |
| 360 </dd> | 371 </dd> |
| 361 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> | 372 </dl><a NAME="ModuleDocument.__genModuleSection" ID="ModuleDocument.__genModuleSection"></a> |
| 362 <h4>ModuleDocument.__genModuleSection</h4> | 373 <h4>ModuleDocument.__genModuleSection</h4> |
| 363 <b>__genModuleSection</b>(<i></i>) | 374 <b>__genModuleSection</b>(<i></i>) |
| 364 <p> | 375 <p> |
| 594 Exception | 605 Exception |
| 595 <h3>Class Attributes</h3> | 606 <h3>Class Attributes</h3> |
| 596 <table> | 607 <table> |
| 597 <tr><td>None</td></tr> | 608 <tr><td>None</td></tr> |
| 598 </table> | 609 </table> |
| 610 <h3>Class Methods</h3> | |
| 611 <table> | |
| 612 <tr><td>None</td></tr> | |
| 613 </table> | |
| 599 <h3>Methods</h3> | 614 <h3>Methods</h3> |
| 615 <table> | |
| 616 <tr><td>None</td></tr> | |
| 617 </table> | |
| 618 <h3>Static Methods</h3> | |
| 600 <table> | 619 <table> |
| 601 <tr><td>None</td></tr> | 620 <tr><td>None</td></tr> |
| 602 </table> | 621 </table> |
| 603 | 622 |
| 604 <div align="right"><a href="#top">Up</a></div> | 623 <div align="right"><a href="#top">Up</a></div> |
