Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html
src/eric7/Documentation/Source/eric7.Plugins.PluginEricdoc.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10437
- 2f70ca07f0af
- child 10684
- 58c7f23ae1cb
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.Plugins.PluginEricdoc</h1> | 9 <h1>eric7.Plugins.PluginEricdoc</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing the Ericdoc plugin. | 11 Module implementing the Ericdoc plugin. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>__header__</td></tr> |
| 17 <tr><td>__header__</td></tr><tr><td>error</td></tr> | 17 <tr><td>error</td></tr> |
| 18 </table> | 18 </table> |
| 19 | |
| 19 <h3>Classes</h3> | 20 <h3>Classes</h3> |
| 20 | 21 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 22 <tr> |
| 24 <td><a href="#EricdocPlugin">EricdocPlugin</a></td> | 23 <td><a href="#EricdocPlugin">EricdocPlugin</a></td> |
| 25 <td>Class implementing the Ericdoc plugin.</td> | 24 <td>Class implementing the Ericdoc plugin.</td> |
| 26 </tr> | 25 </tr> |
| 27 </table> | 26 </table> |
| 27 | |
| 28 <h3>Functions</h3> | 28 <h3>Functions</h3> |
| 29 | 29 <table> |
| 30 <table> | |
| 31 | |
| 32 <tr> | 30 <tr> |
| 33 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> | 31 <td><a href="#exeDisplayDataList">exeDisplayDataList</a></td> |
| 34 <td>Public method to support the display of some executable info.</td> | 32 <td>Public method to support the display of some executable info.</td> |
| 35 </tr> | 33 </tr> |
| 36 </table> | 34 </table> |
| 35 | |
| 37 <hr /> | 36 <hr /> |
| 38 <hr /> | 37 <hr /> |
| 39 <a NAME="EricdocPlugin" ID="EricdocPlugin"></a> | 38 <a NAME="EricdocPlugin" ID="EricdocPlugin"></a> |
| 40 <h2>EricdocPlugin</h2> | 39 <h2>EricdocPlugin</h2> |
| 41 | |
| 42 <p> | 40 <p> |
| 43 Class implementing the Ericdoc plugin. | 41 Class implementing the Ericdoc plugin. |
| 44 </p> | 42 </p> |
| 43 | |
| 45 <h3>Derived from</h3> | 44 <h3>Derived from</h3> |
| 46 QObject | 45 QObject |
| 47 <h3>Class Attributes</h3> | 46 <h3>Class Attributes</h3> |
| 48 | |
| 49 <table> | 47 <table> |
| 50 <tr><td>None</td></tr> | 48 <tr><td>None</td></tr> |
| 51 </table> | 49 </table> |
| 50 | |
| 52 <h3>Class Methods</h3> | 51 <h3>Class Methods</h3> |
| 53 | |
| 54 <table> | 52 <table> |
| 55 <tr><td>None</td></tr> | 53 <tr><td>None</td></tr> |
| 56 </table> | 54 </table> |
| 55 | |
| 57 <h3>Methods</h3> | 56 <h3>Methods</h3> |
| 58 | 57 <table> |
| 59 <table> | |
| 60 | |
| 61 <tr> | 58 <tr> |
| 62 <td><a href="#EricdocPlugin.__init__">EricdocPlugin</a></td> | 59 <td><a href="#EricdocPlugin.__init__">EricdocPlugin</a></td> |
| 63 <td>Constructor</td> | 60 <td>Constructor</td> |
| 64 </tr> | 61 </tr> |
| 65 <tr> | 62 <tr> |
| 89 <tr> | 86 <tr> |
| 90 <td><a href="#EricdocPlugin.deactivate">deactivate</a></td> | 87 <td><a href="#EricdocPlugin.deactivate">deactivate</a></td> |
| 91 <td>Public method to deactivate this plugin.</td> | 88 <td>Public method to deactivate this plugin.</td> |
| 92 </tr> | 89 </tr> |
| 93 </table> | 90 </table> |
| 91 | |
| 94 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 95 | |
| 96 <table> | 93 <table> |
| 97 <tr><td>None</td></tr> | 94 <tr><td>None</td></tr> |
| 98 </table> | 95 </table> |
| 96 | |
| 99 | 97 |
| 100 <a NAME="EricdocPlugin.__init__" ID="EricdocPlugin.__init__"></a> | 98 <a NAME="EricdocPlugin.__init__" ID="EricdocPlugin.__init__"></a> |
| 101 <h4>EricdocPlugin (Constructor)</h4> | 99 <h4>EricdocPlugin (Constructor)</h4> |
| 102 <b>EricdocPlugin</b>(<i>ui</i>) | 100 <b>EricdocPlugin</b>(<i>ui</i>) |
| 103 | |
| 104 <p> | 101 <p> |
| 105 Constructor | 102 Constructor |
| 106 </p> | 103 </p> |
| 104 | |
| 107 <dl> | 105 <dl> |
| 108 | 106 |
| 109 <dt><i>ui</i> (UserInterface)</dt> | 107 <dt><i>ui</i> (UserInterface)</dt> |
| 110 <dd> | 108 <dd> |
| 111 reference to the user interface object | 109 reference to the user interface object |
| 112 </dd> | 110 </dd> |
| 113 </dl> | 111 </dl> |
| 114 <a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> | 112 <a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> |
| 115 <h4>EricdocPlugin.__doEricdoc</h4> | 113 <h4>EricdocPlugin.__doEricdoc</h4> |
| 116 <b>__doEricdoc</b>(<i></i>) | 114 <b>__doEricdoc</b>(<i></i>) |
| 117 | |
| 118 <p> | 115 <p> |
| 119 Private slot to perform the eric7_doc api documentation generation. | 116 Private slot to perform the eric7_doc api documentation generation. |
| 120 </p> | 117 </p> |
| 118 | |
| 121 <a NAME="EricdocPlugin.__ericdocProcessFinished" ID="EricdocPlugin.__ericdocProcessFinished"></a> | 119 <a NAME="EricdocPlugin.__ericdocProcessFinished" ID="EricdocPlugin.__ericdocProcessFinished"></a> |
| 122 <h4>EricdocPlugin.__ericdocProcessFinished</h4> | 120 <h4>EricdocPlugin.__ericdocProcessFinished</h4> |
| 123 <b>__ericdocProcessFinished</b>(<i></i>) | 121 <b>__ericdocProcessFinished</b>(<i></i>) |
| 124 | |
| 125 <p> | 122 <p> |
| 126 Private slot to perform actions after the documentation was generated. | 123 Private slot to perform actions after the documentation was generated. |
| 127 </p> | 124 </p> |
| 125 | |
| 128 <a NAME="EricdocPlugin.__execDialogFinished" ID="EricdocPlugin.__execDialogFinished"></a> | 126 <a NAME="EricdocPlugin.__execDialogFinished" ID="EricdocPlugin.__execDialogFinished"></a> |
| 129 <h4>EricdocPlugin.__execDialogFinished</h4> | 127 <h4>EricdocPlugin.__execDialogFinished</h4> |
| 130 <b>__execDialogFinished</b>(<i></i>) | 128 <b>__execDialogFinished</b>(<i></i>) |
| 131 | |
| 132 <p> | 129 <p> |
| 133 Private slot to handle the execution dialog being closed. | 130 Private slot to handle the execution dialog being closed. |
| 134 </p> | 131 </p> |
| 132 | |
| 135 <a NAME="EricdocPlugin.__initialize" ID="EricdocPlugin.__initialize"></a> | 133 <a NAME="EricdocPlugin.__initialize" ID="EricdocPlugin.__initialize"></a> |
| 136 <h4>EricdocPlugin.__initialize</h4> | 134 <h4>EricdocPlugin.__initialize</h4> |
| 137 <b>__initialize</b>(<i></i>) | 135 <b>__initialize</b>(<i></i>) |
| 138 | |
| 139 <p> | 136 <p> |
| 140 Private slot to (re)initialize the plugin. | 137 Private slot to (re)initialize the plugin. |
| 141 </p> | 138 </p> |
| 139 | |
| 142 <a NAME="EricdocPlugin.__projectShowMenu" ID="EricdocPlugin.__projectShowMenu"></a> | 140 <a NAME="EricdocPlugin.__projectShowMenu" ID="EricdocPlugin.__projectShowMenu"></a> |
| 143 <h4>EricdocPlugin.__projectShowMenu</h4> | 141 <h4>EricdocPlugin.__projectShowMenu</h4> |
| 144 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | 142 <b>__projectShowMenu</b>(<i>menuName, menu</i>) |
| 145 | |
| 146 <p> | 143 <p> |
| 147 Private slot called, when the the project menu or a submenu is | 144 Private slot called, when the the project menu or a submenu is |
| 148 about to be shown. | 145 about to be shown. |
| 149 </p> | 146 </p> |
| 147 | |
| 150 <dl> | 148 <dl> |
| 151 | 149 |
| 152 <dt><i>menuName</i> (str)</dt> | 150 <dt><i>menuName</i> (str)</dt> |
| 153 <dd> | 151 <dd> |
| 154 name of the menu to be shown | 152 name of the menu to be shown |
| 159 </dd> | 157 </dd> |
| 160 </dl> | 158 </dl> |
| 161 <a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> | 159 <a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> |
| 162 <h4>EricdocPlugin.activate</h4> | 160 <h4>EricdocPlugin.activate</h4> |
| 163 <b>activate</b>(<i></i>) | 161 <b>activate</b>(<i></i>) |
| 164 | |
| 165 <p> | 162 <p> |
| 166 Public method to activate this plugin. | 163 Public method to activate this plugin. |
| 167 </p> | 164 </p> |
| 165 | |
| 168 <dl> | 166 <dl> |
| 169 <dt>Return:</dt> | 167 <dt>Return:</dt> |
| 170 <dd> | 168 <dd> |
| 171 tuple of None and activation status | 169 tuple of None and activation status |
| 172 </dd> | 170 </dd> |
| 178 </dd> | 176 </dd> |
| 179 </dl> | 177 </dl> |
| 180 <a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> | 178 <a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> |
| 181 <h4>EricdocPlugin.deactivate</h4> | 179 <h4>EricdocPlugin.deactivate</h4> |
| 182 <b>deactivate</b>(<i></i>) | 180 <b>deactivate</b>(<i></i>) |
| 183 | |
| 184 <p> | 181 <p> |
| 185 Public method to deactivate this plugin. | 182 Public method to deactivate this plugin. |
| 186 </p> | 183 </p> |
| 184 | |
| 187 <div align="right"><a href="#top">Up</a></div> | 185 <div align="right"><a href="#top">Up</a></div> |
| 188 <hr /> | 186 <hr /> |
| 189 <hr /> | 187 <hr /> |
| 190 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> | 188 <a NAME="exeDisplayDataList" ID="exeDisplayDataList"></a> |
| 191 <h2>exeDisplayDataList</h2> | 189 <h2>exeDisplayDataList</h2> |
| 192 <b>exeDisplayDataList</b>(<i></i>) | 190 <b>exeDisplayDataList</b>(<i></i>) |
| 193 | |
| 194 <p> | 191 <p> |
| 195 Public method to support the display of some executable info. | 192 Public method to support the display of some executable info. |
| 196 </p> | 193 </p> |
| 194 | |
| 197 <dl> | 195 <dl> |
| 198 <dt>Return:</dt> | 196 <dt>Return:</dt> |
| 199 <dd> | 197 <dd> |
| 200 dictionary containing the data to query the presence of | 198 dictionary containing the data to query the presence of |
| 201 the executable | 199 the executable |
