Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
- changeset 945
- 8cd4d08fa9f6
- parent 440
- 69ace3e2dcf6
- child 1228
- 7afaf2fca55b
equal
deleted
inserted
replaced
| 944:1b59c4ba121e | 945:8cd4d08fa9f6 |
|---|---|
| 149 <td>Public method used to get the short description of the module.</td> | 149 <td>Public method used to get the short description of the module.</td> |
| 150 </tr> | 150 </tr> |
| 151 </table> | 151 </table> |
| 152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> | 152 <a NAME="ModuleDocument.__init__" ID="ModuleDocument.__init__"></a> |
| 153 <h4>ModuleDocument (Constructor)</h4> | 153 <h4>ModuleDocument (Constructor)</h4> |
| 154 <b>ModuleDocument</b>(<i>module, colors, stylesheet = None</i>) | 154 <b>ModuleDocument</b>(<i>module, colors, stylesheet=None</i>) |
| 155 <p> | 155 <p> |
| 156 Constructor | 156 Constructor |
| 157 </p><dl> | 157 </p><dl> |
| 158 <dt><i>module</i></dt> | 158 <dt><i>module</i></dt> |
| 159 <dd> | 159 <dd> |
| 168 </dd> | 168 </dd> |
| 169 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> | 169 </dl><a NAME="ModuleDocument.__checkDeprecated" ID="ModuleDocument.__checkDeprecated"></a> |
| 170 <h4>ModuleDocument.__checkDeprecated</h4> | 170 <h4>ModuleDocument.__checkDeprecated</h4> |
| 171 <b>__checkDeprecated</b>(<i>descr</i>) | 171 <b>__checkDeprecated</b>(<i>descr</i>) |
| 172 <p> | 172 <p> |
| 173 Private method to check, if the object to be documented contains a | 173 Private method to check, if the object to be documented contains a |
| 174 deprecated flag. | 174 deprecated flag. |
| 175 </p><dl> | 175 </p><dl> |
| 176 <dt><i>desc</i></dt> | 176 <dt><i>desc</i></dt> |
| 177 <dd> | 177 <dd> |
| 178 The documentation string. (string) | 178 The documentation string. (string) |
| 279 <dd> | 279 <dd> |
| 280 The functions details section. (string) | 280 The functions details section. (string) |
| 281 </dd> | 281 </dd> |
| 282 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> | 282 </dl><a NAME="ModuleDocument.__genGlobalsListSection" ID="ModuleDocument.__genGlobalsListSection"></a> |
| 283 <h4>ModuleDocument.__genGlobalsListSection</h4> | 283 <h4>ModuleDocument.__genGlobalsListSection</h4> |
| 284 <b>__genGlobalsListSection</b>(<i>class_ = None</i>) | 284 <b>__genGlobalsListSection</b>(<i>class_=None</i>) |
| 285 <p> | 285 <p> |
| 286 Private method to generate the section listing all global attributes of | 286 Private method to generate the section listing all global attributes of |
| 287 the module. | 287 the module. |
| 288 </p><dl> | 288 </p><dl> |
| 289 <dt><i>class_</i></dt> | 289 <dt><i>class_</i></dt> |
| 295 <dd> | 295 <dd> |
| 296 The globals list section. (string) | 296 The globals list section. (string) |
| 297 </dd> | 297 </dd> |
| 298 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> | 298 </dl><a NAME="ModuleDocument.__genListSection" ID="ModuleDocument.__genListSection"></a> |
| 299 <h4>ModuleDocument.__genListSection</h4> | 299 <h4>ModuleDocument.__genListSection</h4> |
| 300 <b>__genListSection</b>(<i>names, dict, kwSuffix = ""</i>) | 300 <b>__genListSection</b>(<i>names, dict, kwSuffix=""</i>) |
| 301 <p> | 301 <p> |
| 302 Private method to generate a list section of the document. | 302 Private method to generate a list section of the document. |
| 303 </p><dl> | 303 </p><dl> |
| 304 <dt><i>names</i></dt> | 304 <dt><i>names</i></dt> |
| 305 <dd> | 305 <dd> |
| 447 </dd> | 447 </dd> |
| 448 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> | 448 </dl><a NAME="ModuleDocument.__genRbModulesListSection" ID="ModuleDocument.__genRbModulesListSection"></a> |
| 449 <h4>ModuleDocument.__genRbModulesListSection</h4> | 449 <h4>ModuleDocument.__genRbModulesListSection</h4> |
| 450 <b>__genRbModulesListSection</b>(<i></i>) | 450 <b>__genRbModulesListSection</b>(<i></i>) |
| 451 <p> | 451 <p> |
| 452 Private method to generate the section listing all modules of the file | 452 Private method to generate the section listing all modules of the file |
| 453 (Ruby only). | 453 (Ruby only). |
| 454 </p><dl> | 454 </p><dl> |
| 455 <dt>Returns:</dt> | 455 <dt>Returns:</dt> |
| 456 <dd> | 456 <dd> |
| 457 The modules list section. (string) | 457 The modules list section. (string) |
