Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html
src/eric7/Documentation/Source/eric7.DocumentationTools.IndexGenerator.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DocumentationTools.IndexGenerator</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.DocumentationTools.IndexGenerator</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the index generator for the builtin documentation | |
| 13 generator. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 | |
| 17 <table> | |
| 18 <tr><td>None</td></tr> | |
| 19 </table> | |
| 20 <h3>Classes</h3> | |
| 21 | |
| 22 <table> | |
| 23 | |
| 24 <tr> | |
| 25 <td><a href="#IndexGenerator">IndexGenerator</a></td> | |
| 26 <td>Class implementing the index generator for the builtin documentation generator.</td> | |
| 27 </tr> | |
| 28 </table> | |
| 29 <h3>Functions</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <hr /> | |
| 35 <hr /> | |
| 36 <a NAME="IndexGenerator" ID="IndexGenerator"></a> | |
| 37 <h2>IndexGenerator</h2> | |
| 38 | |
| 39 <p> | |
| 40 Class implementing the index generator for the builtin documentation | |
| 41 generator. | |
| 42 </p> | |
| 43 <h3>Derived from</h3> | |
| 44 None | |
| 45 <h3>Class Attributes</h3> | |
| 46 | |
| 47 <table> | |
| 48 <tr><td>None</td></tr> | |
| 49 </table> | |
| 50 <h3>Class Methods</h3> | |
| 51 | |
| 52 <table> | |
| 53 <tr><td>None</td></tr> | |
| 54 </table> | |
| 55 <h3>Methods</h3> | |
| 56 | |
| 57 <table> | |
| 58 | |
| 59 <tr> | |
| 60 <td><a href="#IndexGenerator.__init__">IndexGenerator</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr> | |
| 63 <tr> | |
| 64 <td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td> | |
| 65 <td>Private method to generate an index file for a package.</td> | |
| 66 </tr> | |
| 67 <tr> | |
| 68 <td><a href="#IndexGenerator.remember">remember</a></td> | |
| 69 <td>Public method to remember a documentation file.</td> | |
| 70 </tr> | |
| 71 <tr> | |
| 72 <td><a href="#IndexGenerator.writeIndices">writeIndices</a></td> | |
| 73 <td>Public method to generate all index files.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <h3>Static Methods</h3> | |
| 77 | |
| 78 <table> | |
| 79 <tr><td>None</td></tr> | |
| 80 </table> | |
| 81 | |
| 82 <a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a> | |
| 83 <h4>IndexGenerator (Constructor)</h4> | |
| 84 <b>IndexGenerator</b>(<i>outputDir</i>) | |
| 85 | |
| 86 <p> | |
| 87 Constructor | |
| 88 </p> | |
| 89 <dl> | |
| 90 | |
| 91 <dt><i>outputDir</i> (str)</dt> | |
| 92 <dd> | |
| 93 The output directory for the files | |
| 94 </dd> | |
| 95 </dl> | |
| 96 <a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a> | |
| 97 <h4>IndexGenerator.__writeIndex</h4> | |
| 98 <b>__writeIndex</b>(<i>packagename, package, newline=None</i>) | |
| 99 | |
| 100 <p> | |
| 101 Private method to generate an index file for a package. | |
| 102 </p> | |
| 103 <dl> | |
| 104 | |
| 105 <dt><i>packagename</i></dt> | |
| 106 <dd> | |
| 107 The name of the package. (string) | |
| 108 </dd> | |
| 109 <dt><i>package</i></dt> | |
| 110 <dd> | |
| 111 A dictionary with information about the package. | |
| 112 </dd> | |
| 113 <dt><i>newline</i></dt> | |
| 114 <dd> | |
| 115 newline character to be used (string) | |
| 116 </dd> | |
| 117 </dl> | |
| 118 <dl> | |
| 119 <dt>Return:</dt> | |
| 120 <dd> | |
| 121 The name of the generated index file. | |
| 122 </dd> | |
| 123 </dl> | |
| 124 <a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a> | |
| 125 <h4>IndexGenerator.remember</h4> | |
| 126 <b>remember</b>(<i>file, moduleDocument, basename=""</i>) | |
| 127 | |
| 128 <p> | |
| 129 Public method to remember a documentation file. | |
| 130 </p> | |
| 131 <dl> | |
| 132 | |
| 133 <dt><i>file</i></dt> | |
| 134 <dd> | |
| 135 The filename to be remembered. (string) | |
| 136 </dd> | |
| 137 <dt><i>moduleDocument</i></dt> | |
| 138 <dd> | |
| 139 The ModuleDocument object containing the | |
| 140 information for the file. | |
| 141 </dd> | |
| 142 <dt><i>basename</i></dt> | |
| 143 <dd> | |
| 144 The basename of the file hierarchy to be documented. | |
| 145 The basename is stripped off the filename if it starts with | |
| 146 the basename. | |
| 147 </dd> | |
| 148 </dl> | |
| 149 <a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a> | |
| 150 <h4>IndexGenerator.writeIndices</h4> | |
| 151 <b>writeIndices</b>(<i>basename="", newline=None</i>) | |
| 152 | |
| 153 <p> | |
| 154 Public method to generate all index files. | |
| 155 </p> | |
| 156 <dl> | |
| 157 | |
| 158 <dt><i>basename</i></dt> | |
| 159 <dd> | |
| 160 The basename of the file hierarchy to be documented. | |
| 161 The basename is stripped off the filename if it starts with | |
| 162 the basename. | |
| 163 </dd> | |
| 164 <dt><i>newline</i></dt> | |
| 165 <dd> | |
| 166 newline character to be used (string) | |
| 167 </dd> | |
| 168 </dl> | |
| 169 <div align="right"><a href="#top">Up</a></div> | |
| 170 <hr /> | |
| 171 </body></html> |
