Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.DocumentationTools.APIGenerator.html
Documentation/Source/eric4.DocumentationTools.APIGenerator.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.DocumentationTools.APIGenerator</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.DocumentationTools.APIGenerator</h1> | |
| 24 <p> | |
| 25 Module implementing the builtin API generator. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#APIGenerator">APIGenerator</a></td> | |
| 35 <td>Class implementing the builtin documentation generator.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="APIGenerator" ID="APIGenerator"></a> | |
| 44 <h2>APIGenerator</h2> | |
| 45 <p> | |
| 46 Class implementing the builtin documentation generator. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 object | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#APIGenerator.__init__">APIGenerator</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#APIGenerator.__addClassVariablesAPI">__addClassVariablesAPI</a></td> | |
| 61 <td>Private method to generate class api section for class variables.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#APIGenerator.__addClassesAPI">__addClassesAPI</a></td> | |
| 64 <td>Private method to generate the api section for classes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#APIGenerator.__addFunctionsAPI">__addFunctionsAPI</a></td> | |
| 67 <td>Private method to generate the api section for functions.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#APIGenerator.__addGlobalsAPI">__addGlobalsAPI</a></td> | |
| 70 <td>Private method to generate the api section for global variables.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#APIGenerator.__addMethodsAPI">__addMethodsAPI</a></td> | |
| 73 <td>Private method to generate the api section for class methods.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#APIGenerator.__isPrivate">__isPrivate</a></td> | |
| 76 <td>Private method to check, if an object is considered private.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#APIGenerator.genAPI">genAPI</a></td> | |
| 79 <td>Method to generate the source code documentation.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="APIGenerator.__init__" ID="APIGenerator.__init__"></a> | |
| 83 <h4>APIGenerator (Constructor)</h4> | |
| 84 <b>APIGenerator</b>(<i>module</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>module</i></dt> | |
| 89 <dd> | |
| 90 The information of the parsed Python file. | |
| 91 </dd> | |
| 92 </dl><a NAME="APIGenerator.__addClassVariablesAPI" ID="APIGenerator.__addClassVariablesAPI"></a> | |
| 93 <h4>APIGenerator.__addClassVariablesAPI</h4> | |
| 94 <b>__addClassVariablesAPI</b>(<i>className</i>) | |
| 95 <p> | |
| 96 Private method to generate class api section for class variables. | |
| 97 </p><dl> | |
| 98 <dt><i>classname</i></dt> | |
| 99 <dd> | |
| 100 Name of the class containing the class variables. (string) | |
| 101 </dd> | |
| 102 </dl><a NAME="APIGenerator.__addClassesAPI" ID="APIGenerator.__addClassesAPI"></a> | |
| 103 <h4>APIGenerator.__addClassesAPI</h4> | |
| 104 <b>__addClassesAPI</b>(<i></i>) | |
| 105 <p> | |
| 106 Private method to generate the api section for classes. | |
| 107 </p><a NAME="APIGenerator.__addFunctionsAPI" ID="APIGenerator.__addFunctionsAPI"></a> | |
| 108 <h4>APIGenerator.__addFunctionsAPI</h4> | |
| 109 <b>__addFunctionsAPI</b>(<i></i>) | |
| 110 <p> | |
| 111 Private method to generate the api section for functions. | |
| 112 </p><a NAME="APIGenerator.__addGlobalsAPI" ID="APIGenerator.__addGlobalsAPI"></a> | |
| 113 <h4>APIGenerator.__addGlobalsAPI</h4> | |
| 114 <b>__addGlobalsAPI</b>(<i></i>) | |
| 115 <p> | |
| 116 Private method to generate the api section for global variables. | |
| 117 </p><a NAME="APIGenerator.__addMethodsAPI" ID="APIGenerator.__addMethodsAPI"></a> | |
| 118 <h4>APIGenerator.__addMethodsAPI</h4> | |
| 119 <b>__addMethodsAPI</b>(<i>className</i>) | |
| 120 <p> | |
| 121 Private method to generate the api section for class methods. | |
| 122 </p><dl> | |
| 123 <dt><i>classname</i></dt> | |
| 124 <dd> | |
| 125 Name of the class containing the method. (string) | |
| 126 </dd> | |
| 127 </dl><a NAME="APIGenerator.__isPrivate" ID="APIGenerator.__isPrivate"></a> | |
| 128 <h4>APIGenerator.__isPrivate</h4> | |
| 129 <b>__isPrivate</b>(<i>obj</i>) | |
| 130 <p> | |
| 131 Private method to check, if an object is considered private. | |
| 132 </p><dl> | |
| 133 <dt><i>obj</i></dt> | |
| 134 <dd> | |
| 135 reference to the object to be checked | |
| 136 </dd> | |
| 137 </dl><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 flag indicating, that object is considered private (boolean) | |
| 141 </dd> | |
| 142 </dl><a NAME="APIGenerator.genAPI" ID="APIGenerator.genAPI"></a> | |
| 143 <h4>APIGenerator.genAPI</h4> | |
| 144 <b>genAPI</b>(<i>newStyle, basePackage, includePrivate</i>) | |
| 145 <p> | |
| 146 Method to generate the source code documentation. | |
| 147 </p><dl> | |
| 148 <dt><i>newStyle</i></dt> | |
| 149 <dd> | |
| 150 flag indicating the api generation for QScintilla 1.7 and | |
| 151 newer (boolean) | |
| 152 </dd><dt><i>basePackage</i></dt> | |
| 153 <dd> | |
| 154 name of the base package (string) | |
| 155 </dd><dt><i>includePrivate</i></dt> | |
| 156 <dd> | |
| 157 flag indicating to include | |
| 158 private methods/functions (boolean) | |
| 159 </dd> | |
| 160 </dl><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 The API information. (string) | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <div align="right"><a href="#top">Up</a></div> | |
| 167 <hr /> | |
| 168 </body></html> |
