Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
Documentation/Source/eric5.DocumentationTools.ModuleDocumentor.html
- changeset 2966
- f85f686981ad
- parent 2387
- 2d119e79ab54
- child 3018
- 70924c0bdaf1
equal
deleted
inserted
replaced
| 2965:d133c7edd88a | 2966:f85f686981ad |
|---|---|
| 178 <b>__checkDeprecated</b>(<i>descr</i>) | 178 <b>__checkDeprecated</b>(<i>descr</i>) |
| 179 <p> | 179 <p> |
| 180 Private method to check, if the object to be documented contains a | 180 Private method to check, if the object to be documented contains a |
| 181 deprecated flag. | 181 deprecated flag. |
| 182 </p><dl> | 182 </p><dl> |
| 183 <dt><i>desc</i></dt> | 183 <dt><i>descr</i></dt> |
| 184 <dd> | 184 <dd> |
| 185 The documentation string. (string) | 185 documentation string (string) |
| 186 </dd> | 186 </dd> |
| 187 </dl><dl> | 187 </dl><dl> |
| 188 <dt>Returns:</dt> | 188 <dt>Returns:</dt> |
| 189 <dd> | 189 <dd> |
| 190 Flag indicating the deprecation status. (boolean) | 190 flag indicating the deprecation status (boolean) |
| 191 </dd> | 191 </dd> |
| 192 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> | 192 </dl><a NAME="ModuleDocument.__formatCrossReferenceEntry" ID="ModuleDocument.__formatCrossReferenceEntry"></a> |
| 193 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> | 193 <h4>ModuleDocument.__formatCrossReferenceEntry</h4> |
| 194 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) | 194 <b>__formatCrossReferenceEntry</b>(<i>entry</i>) |
| 195 <p> | 195 <p> |
| 528 </dl><dl> | 528 </dl><dl> |
| 529 <dt>Returns:</dt> | 529 <dt>Returns:</dt> |
| 530 <dd> | 530 <dd> |
| 531 processed line with inline tags expanded (string) | 531 processed line with inline tags expanded (string) |
| 532 </dd> | 532 </dd> |
| 533 </dl><dl> | |
| 534 <dt>Raises <b>TagError</b>:</dt> | |
| 535 <dd> | |
| 536 raised to indicate an invalid tag | |
| 537 </dd> | |
| 533 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> | 538 </dl><a NAME="ModuleDocument.description" ID="ModuleDocument.description"></a> |
| 534 <h4>ModuleDocument.description</h4> | 539 <h4>ModuleDocument.description</h4> |
| 535 <b>description</b>(<i></i>) | 540 <b>description</b>(<i></i>) |
| 536 <p> | 541 <p> |
| 537 Public method used to get the description of the module. | 542 Public method used to get the description of the module. |
