Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.IndexGenerator.html
Documentation/Source/eric5.DocumentationTools.IndexGenerator.html
- changeset 253
- 3ccdf551bde7
- parent 58
- 37f0444c3479
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 252:05692e3d37bf | 253:3ccdf551bde7 |
|---|---|
| 84 <dd> | 84 <dd> |
| 85 the style to be used for the generated pages (string) | 85 the style to be used for the generated pages (string) |
| 86 </dd> | 86 </dd> |
| 87 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | 87 </dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> |
| 88 <h4>IndexGenerator.__writeIndex</h4> | 88 <h4>IndexGenerator.__writeIndex</h4> |
| 89 <b>__writeIndex</b>(<i>packagename, package</i>) | 89 <b>__writeIndex</b>(<i>packagename, package, newline = None</i>) |
| 90 <p> | 90 <p> |
| 91 Private method to generate an index file for a package. | 91 Private method to generate an index file for a package. |
| 92 </p><dl> | 92 </p><dl> |
| 93 <dt><i>packagename</i></dt> | 93 <dt><i>packagename</i></dt> |
| 94 <dd> | 94 <dd> |
| 95 The name of the package. (string) | 95 The name of the package. (string) |
| 96 </dd><dt><i>package</i></dt> | 96 </dd><dt><i>package</i></dt> |
| 97 <dd> | 97 <dd> |
| 98 A dictionary with information about the package. | 98 A dictionary with information about the package. |
| 99 </dd><dt><i>newline</i></dt> | |
| 100 <dd> | |
| 101 newline character to be used (string) | |
| 99 </dd> | 102 </dd> |
| 100 </dl><dl> | 103 </dl><dl> |
| 101 <dt>Returns:</dt> | 104 <dt>Returns:</dt> |
| 102 <dd> | 105 <dd> |
| 103 The name of the generated index file. | 106 The name of the generated index file. |
| 121 The basename is stripped off the filename if it starts with | 124 The basename is stripped off the filename if it starts with |
| 122 the basename. | 125 the basename. |
| 123 </dd> | 126 </dd> |
| 124 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | 127 </dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> |
| 125 <h4>IndexGenerator.writeIndices</h4> | 128 <h4>IndexGenerator.writeIndices</h4> |
| 126 <b>writeIndices</b>(<i>basename = ""</i>) | 129 <b>writeIndices</b>(<i>basename = "", newline = None</i>) |
| 127 <p> | 130 <p> |
| 128 Public method to generate all index files. | 131 Public method to generate all index files. |
| 129 </p><dl> | 132 </p><dl> |
| 130 <dt><i>basename</i></dt> | 133 <dt><i>basename</i></dt> |
| 131 <dd> | 134 <dd> |
| 132 The basename of the file hierarchy to be documented. | 135 The basename of the file hierarchy to be documented. |
| 133 The basename is stripped off the filename if it starts with | 136 The basename is stripped off the filename if it starts with |
| 134 the basename. | 137 the basename. |
| 138 </dd><dt><i>newline</i></dt> | |
| 139 <dd> | |
| 140 newline character to be used (string) | |
| 135 </dd> | 141 </dd> |
| 136 </dl> | 142 </dl> |
| 137 <div align="right"><a href="#top">Up</a></div> | 143 <div align="right"><a href="#top">Up</a></div> |
| 138 <hr /> | 144 <hr /> |
| 139 </body></html> | 145 </body></html> |
