Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html
src/eric7/Documentation/Source/eric7.DocumentationTools.APIGenerator.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.DocumentationTools.APIGenerator</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.APIGenerator</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the builtin API generator. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#APIGenerator">APIGenerator</a></td> | |
| 25 <td>Class implementing the builtin documentation generator.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="APIGenerator" ID="APIGenerator"></a> | |
| 36 <h2>APIGenerator</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the builtin documentation generator. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 None | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#APIGenerator.__init__">APIGenerator</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td> | |
| 63 <td>Private method to generate class api section for class variables.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td> | |
| 67 <td>Private method to generate the api section for classes.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td> | |
| 71 <td>Private method to generate the api section for functions.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td> | |
| 75 <td>Private method to generate the api section for global variables.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td> | |
| 79 <td>Private method to generate the api section for class methods.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td> | |
| 83 <td>Private method to check, if an object is considered private.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#APIGenerator.genAPI">genAPI</a></td> | |
| 87 <td>Public method to generate the API information.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#APIGenerator.genBases">genBases</a></td> | |
| 91 <td>Public method to generate the base classes information.</td> | |
| 92 </tr> | |
| 93 </table> | |
| 94 <h3>Static Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 <tr><td>None</td></tr> | |
| 98 </table> | |
| 99 | |
| 100 <a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a> | |
| 101 <h4>APIGenerator (Constructor)</h4> | |
| 102 <b>APIGenerator</b>(<i>module</i>) | |
| 103 | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p> | |
| 107 <dl> | |
| 108 | |
| 109 <dt><i>module</i></dt> | |
| 110 <dd> | |
| 111 The information of the parsed Python file. | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a> | |
| 115 <h4>APIGenerator.__addClassVariablesAPI</h4> | |
| 116 <b>__addClassVariablesAPI</b>(<i>className</i>) | |
| 117 | |
| 118 <p> | |
| 119 Private method to generate class api section for class variables. | |
| 120 </p> | |
| 121 <dl> | |
| 122 | |
| 123 <dt><i>className</i></dt> | |
| 124 <dd> | |
| 125 name of the class containing the class variables | |
| 126 (string) | |
| 127 </dd> | |
| 128 </dl> | |
| 129 <a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a> | |
| 130 <h4>APIGenerator.__addClassesAPI</h4> | |
| 131 <b>__addClassesAPI</b>(<i></i>) | |
| 132 | |
| 133 <p> | |
| 134 Private method to generate the api section for classes. | |
| 135 </p> | |
| 136 <a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a> | |
| 137 <h4>APIGenerator.__addFunctionsAPI</h4> | |
| 138 <b>__addFunctionsAPI</b>(<i></i>) | |
| 139 | |
| 140 <p> | |
| 141 Private method to generate the api section for functions. | |
| 142 </p> | |
| 143 <a NAME="APIGenerator.__addGlobalsAPI" ID="APIGenerator.__addGlobalsAPI"></a> | |
| 144 <h4>APIGenerator.__addGlobalsAPI</h4> | |
| 145 <b>__addGlobalsAPI</b>(<i></i>) | |
| 146 | |
| 147 <p> | |
| 148 Private method to generate the api section for global variables. | |
| 149 </p> | |
| 150 <a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a> | |
| 151 <h4>APIGenerator.__addMethodsAPI</h4> | |
| 152 <b>__addMethodsAPI</b>(<i>className</i>) | |
| 153 | |
| 154 <p> | |
| 155 Private method to generate the api section for class methods. | |
| 156 </p> | |
| 157 <dl> | |
| 158 | |
| 159 <dt><i>className</i></dt> | |
| 160 <dd> | |
| 161 name of the class containing the method (string) | |
| 162 </dd> | |
| 163 </dl> | |
| 164 <a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a> | |
| 165 <h4>APIGenerator.__isPrivate</h4> | |
| 166 <b>__isPrivate</b>(<i>obj</i>) | |
| 167 | |
| 168 <p> | |
| 169 Private method to check, if an object is considered private. | |
| 170 </p> | |
| 171 <dl> | |
| 172 | |
| 173 <dt><i>obj</i></dt> | |
| 174 <dd> | |
| 175 reference to the object to be checked | |
| 176 </dd> | |
| 177 </dl> | |
| 178 <dl> | |
| 179 <dt>Return:</dt> | |
| 180 <dd> | |
| 181 flag indicating, that object is considered private (boolean) | |
| 182 </dd> | |
| 183 </dl> | |
| 184 <a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a> | |
| 185 <h4>APIGenerator.genAPI</h4> | |
| 186 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>) | |
| 187 | |
| 188 <p> | |
| 189 Public method to generate the API information. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>newStyle</i></dt> | |
| 194 <dd> | |
| 195 flag indicating the api generation for QScintilla 1.7 | |
| 196 and newer (boolean) (ignored) | |
| 197 </dd> | |
| 198 <dt><i>basePackage</i></dt> | |
| 199 <dd> | |
| 200 name of the base package (string) | |
| 201 </dd> | |
| 202 <dt><i>includePrivate</i></dt> | |
| 203 <dd> | |
| 204 flag indicating to include | |
| 205 private methods/functions (boolean) | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <dl> | |
| 209 <dt>Return:</dt> | |
| 210 <dd> | |
| 211 API information (list of strings) | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <a NAME="APIGenerator.genBases" ID="APIGenerator.genBases"></a> | |
| 215 <h4>APIGenerator.genBases</h4> | |
| 216 <b>genBases</b>(<i>includePrivate</i>) | |
| 217 | |
| 218 <p> | |
| 219 Public method to generate the base classes information. | |
| 220 </p> | |
| 221 <dl> | |
| 222 | |
| 223 <dt><i>includePrivate</i></dt> | |
| 224 <dd> | |
| 225 flag indicating to include private classes | |
| 226 (boolean) | |
| 227 </dd> | |
| 228 </dl> | |
| 229 <dl> | |
| 230 <dt>Return:</dt> | |
| 231 <dd> | |
| 232 base classes information (dictionary of list of strings) | |
| 233 </dd> | |
| 234 </dl> | |
| 235 <div align="right"><a href="#top">Up</a></div> | |
| 236 <hr /> | |
| 237 </body></html> |
