Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html
eric6/Documentation/Source/eric6.DocumentationTools.APIGenerator.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.DocumentationTools.APIGenerator</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.DocumentationTools.APIGenerator</h1> | |
| 23 <p> | |
| 24 Module implementing the builtin API generator. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#APIGenerator">APIGenerator</a></td> | |
| 34 <td>Class implementing the builtin documentation generator.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="APIGenerator" ID="APIGenerator"></a> | |
| 43 <h2>APIGenerator</h2> | |
| 44 <p> | |
| 45 Class implementing the builtin documentation generator. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 object | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#APIGenerator.__init__">APIGenerator</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td> | |
| 64 <td>Private method to generate class api section for class variables.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td> | |
| 67 <td>Private method to generate the api section for classes.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td> | |
| 70 <td>Private method to generate the api section for functions.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td> | |
| 73 <td>Private method to generate the api section for global variables.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td> | |
| 76 <td>Private method to generate the api section for class methods.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td> | |
| 79 <td>Private method to check, if an object is considered private.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#APIGenerator.genAPI">genAPI</a></td> | |
| 82 <td>Public method to generate the API information.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#APIGenerator.genBases">genBases</a></td> | |
| 85 <td>Public method to generate the base classes information.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <h3>Static Methods</h3> | |
| 89 <table> | |
| 90 <tr><td>None</td></tr> | |
| 91 </table> | |
| 92 <a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a> | |
| 93 <h4>APIGenerator (Constructor)</h4> | |
| 94 <b>APIGenerator</b>(<i>module</i>) | |
| 95 <p> | |
| 96 Constructor | |
| 97 </p><dl> | |
| 98 <dt><i>module</i></dt> | |
| 99 <dd> | |
| 100 The information of the parsed Python file. | |
| 101 </dd> | |
| 102 </dl><a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a> | |
| 103 <h4>APIGenerator.__addClassVariablesAPI</h4> | |
| 104 <b>__addClassVariablesAPI</b>(<i>className</i>) | |
| 105 <p> | |
| 106 Private method to generate class api section for class variables. | |
| 107 </p><dl> | |
| 108 <dt><i>className</i></dt> | |
| 109 <dd> | |
| 110 name of the class containing the class variables | |
| 111 (string) | |
| 112 </dd> | |
| 113 </dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a> | |
| 114 <h4>APIGenerator.__addClassesAPI</h4> | |
| 115 <b>__addClassesAPI</b>(<i></i>) | |
| 116 <p> | |
| 117 Private method to generate the api section for classes. | |
| 118 </p><a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a> | |
| 119 <h4>APIGenerator.__addFunctionsAPI</h4> | |
| 120 <b>__addFunctionsAPI</b>(<i></i>) | |
| 121 <p> | |
| 122 Private method to generate the api section for functions. | |
| 123 </p><a NAME="APIGenerator.__addGlobalsAPI" ID="APIGenerator.__addGlobalsAPI"></a> | |
| 124 <h4>APIGenerator.__addGlobalsAPI</h4> | |
| 125 <b>__addGlobalsAPI</b>(<i></i>) | |
| 126 <p> | |
| 127 Private method to generate the api section for global variables. | |
| 128 </p><a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a> | |
| 129 <h4>APIGenerator.__addMethodsAPI</h4> | |
| 130 <b>__addMethodsAPI</b>(<i>className</i>) | |
| 131 <p> | |
| 132 Private method to generate the api section for class methods. | |
| 133 </p><dl> | |
| 134 <dt><i>className</i></dt> | |
| 135 <dd> | |
| 136 name of the class containing the method (string) | |
| 137 </dd> | |
| 138 </dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a> | |
| 139 <h4>APIGenerator.__isPrivate</h4> | |
| 140 <b>__isPrivate</b>(<i>obj</i>) | |
| 141 <p> | |
| 142 Private method to check, if an object is considered private. | |
| 143 </p><dl> | |
| 144 <dt><i>obj</i></dt> | |
| 145 <dd> | |
| 146 reference to the object to be checked | |
| 147 </dd> | |
| 148 </dl><dl> | |
| 149 <dt>Returns:</dt> | |
| 150 <dd> | |
| 151 flag indicating, that object is considered private (boolean) | |
| 152 </dd> | |
| 153 </dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a> | |
| 154 <h4>APIGenerator.genAPI</h4> | |
| 155 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>) | |
| 156 <p> | |
| 157 Public method to generate the API information. | |
| 158 </p><dl> | |
| 159 <dt><i>newStyle</i></dt> | |
| 160 <dd> | |
| 161 flag indicating the api generation for QScintilla 1.7 | |
| 162 and newer (boolean) (ignored) | |
| 163 </dd><dt><i>basePackage</i></dt> | |
| 164 <dd> | |
| 165 name of the base package (string) | |
| 166 </dd><dt><i>includePrivate</i></dt> | |
| 167 <dd> | |
| 168 flag indicating to include | |
| 169 private methods/functions (boolean) | |
| 170 </dd> | |
| 171 </dl><dl> | |
| 172 <dt>Returns:</dt> | |
| 173 <dd> | |
| 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 | |
| 185 (boolean) | |
| 186 </dd> | |
| 187 </dl><dl> | |
| 188 <dt>Returns:</dt> | |
| 189 <dd> | |
| 190 base classes information (dictionary of list of strings) | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <div align="right"><a href="#top">Up</a></div> | |
| 194 <hr /> | |
| 195 </body></html> |
