Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DocumentationTools.APIGenerator.html
Documentation/Source/eric5.DocumentationTools.APIGenerator.html
- branch
- 5_1_x
- changeset 1344
- 54c50e65173f
- parent 1278
- fb0460fd00b9
equal
deleted
inserted
replaced
| 1340:142ad6decc3a | 1344:54c50e65173f |
|---|---|
| 78 </tr><tr> | 78 </tr><tr> |
| 79 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td> | 79 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td> |
| 80 <td>Private method to check, if an object is considered private.</td> | 80 <td>Private method to check, if an object is considered private.</td> |
| 81 </tr><tr> | 81 </tr><tr> |
| 82 <td><a href="#APIGenerator.genAPI">genAPI</a></td> | 82 <td><a href="#APIGenerator.genAPI">genAPI</a></td> |
| 83 <td>Method to generate the source code documentation.</td> | 83 <td>Public method to generate the API information.</td> |
| 84 </tr><tr> | |
| 85 <td><a href="#APIGenerator.genBases">genBases</a></td> | |
| 86 <td>Public method to generate the base classes information.</td> | |
| 84 </tr> | 87 </tr> |
| 85 </table> | 88 </table> |
| 86 <h3>Static Methods</h3> | 89 <h3>Static Methods</h3> |
| 87 <table> | 90 <table> |
| 88 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 149 </dd> | 152 </dd> |
| 150 </dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a> | 153 </dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a> |
| 151 <h4>APIGenerator.genAPI</h4> | 154 <h4>APIGenerator.genAPI</h4> |
| 152 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>) | 155 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>) |
| 153 <p> | 156 <p> |
| 154 Method to generate the source code documentation. | 157 Public method to generate the API information. |
| 155 </p><dl> | 158 </p><dl> |
| 156 <dt><i>newStyle</i></dt> | 159 <dt><i>newStyle</i></dt> |
| 157 <dd> | 160 <dd> |
| 158 flag indicating the api generation for QScintilla 1.7 and | 161 flag indicating the api generation for QScintilla 1.7 and |
| 159 newer (boolean) (ignored) | 162 newer (boolean) (ignored) |
| 166 private methods/functions (boolean) | 169 private methods/functions (boolean) |
| 167 </dd> | 170 </dd> |
| 168 </dl><dl> | 171 </dl><dl> |
| 169 <dt>Returns:</dt> | 172 <dt>Returns:</dt> |
| 170 <dd> | 173 <dd> |
| 171 The API information. (string) | 174 API information (list of strings) |
| 175 </dd> | |
| 176 </dl><a NAME="APIGenerator.genBases" ID="APIGenerator.genBases"></a> | |
| 177 <h4>APIGenerator.genBases</h4> | |
| 178 <b>genBases</b>(<i>includePrivate</i>) | |
| 179 <p> | |
| 180 Public method to generate the base classes information. | |
| 181 </p><dl> | |
| 182 <dt><i>includePrivate</i></dt> | |
| 183 <dd> | |
| 184 flag indicating to include private classes (boolean) | |
| 185 </dd> | |
| 186 </dl><dl> | |
| 187 <dt>Returns:</dt> | |
| 188 <dd> | |
| 189 base classes information (dictionary of list of strings) | |
| 172 </dd> | 190 </dd> |
| 173 </dl> | 191 </dl> |
| 174 <div align="right"><a href="#top">Up</a></div> | 192 <div align="right"><a href="#top">Up</a></div> |
| 175 <hr /> | 193 <hr /> |
| 176 </body></html> | 194 </body></html> |
