Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Plugins.PluginEricdoc.html
Documentation/Source/eric5.Plugins.PluginEricdoc.html
- changeset 58
- 37f0444c3479
- parent 21
- b88a0e6268bd
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.Plugins.PluginEricdoc</h1> | 23 <h1>eric5.Plugins.PluginEricdoc</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing the Ericdoc plugin. | 25 Module implementing the Ericdoc plugin. |
| 26 </p> | 26 </p> |
| 27 <h3>Global Attributes</h3> | 27 <h3>Global Attributes</h3> |
| 28 <table> | 28 <table> |
| 29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> | 29 <tr><td>author</td></tr><tr><td>autoactivate</td></tr><tr><td>className</td></tr><tr><td>deactivateable</td></tr><tr><td>error</td></tr><tr><td>longDescription</td></tr><tr><td>name</td></tr><tr><td>packageName</td></tr><tr><td>pyqtApi</td></tr><tr><td>shortDescription</td></tr><tr><td>version</td></tr> |
| 30 </table> | 30 </table> |
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#EricdocPlugin">EricdocPlugin</a></td> | 34 <td><a href="#EricdocPlugin">EricdocPlugin</a></td> |
| 35 <td>Class implementing the Ericdoc plugin.</td> | 35 <td>Class implementing the Ericdoc plugin.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr> | 40 <tr> |
| 41 <td><a href="#exeDisplayData">exeDisplayData</a></td> | 41 <td><a href="#exeDisplayData">exeDisplayData</a></td> |
| 42 <td>Public method to support the display of some executable info.</td> | 42 <td>Public method to support the display of some executable info.</td> |
| 43 </tr> | 43 </tr> |
| 44 </table> | 44 </table> |
| 45 <hr /><hr /> | 45 <hr /><hr /> |
| 46 <a NAME="EricdocPlugin" ID="EricdocPlugin"></a> | 46 <a NAME="EricdocPlugin" ID="EricdocPlugin"></a> |
| 47 <h2>EricdocPlugin</h2> | 47 <h2>EricdocPlugin</h2> |
| 48 <p> | 48 <p> |
| 49 Class implementing the Ericdoc plugin. | 49 Class implementing the Ericdoc plugin. |
| 50 </p> | 50 </p> |
| 51 <h3>Derived from</h3> | 51 <h3>Derived from</h3> |
| 52 QObject | 52 QObject |
| 53 <h3>Class Attributes</h3> | 53 <h3>Class Attributes</h3> |
| 54 <table> | 54 <table> |
| 56 </table> | 56 </table> |
| 57 <h3>Methods</h3> | 57 <h3>Methods</h3> |
| 58 <table> | 58 <table> |
| 59 <tr> | 59 <tr> |
| 60 <td><a href="#EricdocPlugin.__init__">EricdocPlugin</a></td> | 60 <td><a href="#EricdocPlugin.__init__">EricdocPlugin</a></td> |
| 61 <td>Constructor</td> | 61 <td>Constructor</td> |
| 62 </tr><tr> | 62 </tr><tr> |
| 63 <td><a href="#EricdocPlugin.__doEricdoc">__doEricdoc</a></td> | 63 <td><a href="#EricdocPlugin.__doEricdoc">__doEricdoc</a></td> |
| 64 <td>Private slot to perform the eric5-doc api documentation generation.</td> | 64 <td>Private slot to perform the eric5-doc api documentation generation.</td> |
| 65 </tr><tr> | 65 </tr><tr> |
| 66 <td><a href="#EricdocPlugin.__initialize">__initialize</a></td> | 66 <td><a href="#EricdocPlugin.__initialize">__initialize</a></td> |
| 67 <td>Private slot to (re)initialize the plugin.</td> | 67 <td>Private slot to (re)initialize the plugin.</td> |
| 68 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#EricdocPlugin.__projectShowMenu">__projectShowMenu</a></td> | 69 <td><a href="#EricdocPlugin.__projectShowMenu">__projectShowMenu</a></td> |
| 70 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> | 70 <td>Private slot called, when the the project menu or a submenu is about to be shown.</td> |
| 71 </tr><tr> | 71 </tr><tr> |
| 72 <td><a href="#EricdocPlugin.activate">activate</a></td> | 72 <td><a href="#EricdocPlugin.activate">activate</a></td> |
| 73 <td>Public method to activate this plugin.</td> | 73 <td>Public method to activate this plugin.</td> |
| 74 </tr><tr> | 74 </tr><tr> |
| 75 <td><a href="#EricdocPlugin.deactivate">deactivate</a></td> | 75 <td><a href="#EricdocPlugin.deactivate">deactivate</a></td> |
| 76 <td>Public method to deactivate this plugin.</td> | 76 <td>Public method to deactivate this plugin.</td> |
| 77 </tr> | 77 </tr> |
| 78 </table> | 78 </table> |
| 79 <a NAME="EricdocPlugin.__init__" ID="EricdocPlugin.__init__"></a> | 79 <a NAME="EricdocPlugin.__init__" ID="EricdocPlugin.__init__"></a> |
| 80 <h4>EricdocPlugin (Constructor)</h4> | 80 <h4>EricdocPlugin (Constructor)</h4> |
| 81 <b>EricdocPlugin</b>(<i>ui</i>) | 81 <b>EricdocPlugin</b>(<i>ui</i>) |
| 82 <p> | 82 <p> |
| 83 Constructor | 83 Constructor |
| 84 </p><dl> | 84 </p><dl> |
| 85 <dt><i>ui</i></dt> | 85 <dt><i>ui</i></dt> |
| 86 <dd> | 86 <dd> |
| 87 reference to the user interface object (UI.UserInterface) | 87 reference to the user interface object (UI.UserInterface) |
| 88 </dd> | 88 </dd> |
| 89 </dl><a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> | 89 </dl><a NAME="EricdocPlugin.__doEricdoc" ID="EricdocPlugin.__doEricdoc"></a> |
| 90 <h4>EricdocPlugin.__doEricdoc</h4> | 90 <h4>EricdocPlugin.__doEricdoc</h4> |
| 91 <b>__doEricdoc</b>(<i></i>) | 91 <b>__doEricdoc</b>(<i></i>) |
| 92 <p> | 92 <p> |
| 93 Private slot to perform the eric5-doc api documentation generation. | 93 Private slot to perform the eric5-doc api documentation generation. |
| 94 </p><a NAME="EricdocPlugin.__initialize" ID="EricdocPlugin.__initialize"></a> | 94 </p><a NAME="EricdocPlugin.__initialize" ID="EricdocPlugin.__initialize"></a> |
| 95 <h4>EricdocPlugin.__initialize</h4> | 95 <h4>EricdocPlugin.__initialize</h4> |
| 96 <b>__initialize</b>(<i></i>) | 96 <b>__initialize</b>(<i></i>) |
| 97 <p> | 97 <p> |
| 98 Private slot to (re)initialize the plugin. | 98 Private slot to (re)initialize the plugin. |
| 99 </p><a NAME="EricdocPlugin.__projectShowMenu" ID="EricdocPlugin.__projectShowMenu"></a> | 99 </p><a NAME="EricdocPlugin.__projectShowMenu" ID="EricdocPlugin.__projectShowMenu"></a> |
| 100 <h4>EricdocPlugin.__projectShowMenu</h4> | 100 <h4>EricdocPlugin.__projectShowMenu</h4> |
| 101 <b>__projectShowMenu</b>(<i>menuName, menu</i>) | 101 <b>__projectShowMenu</b>(<i>menuName, menu</i>) |
| 102 <p> | 102 <p> |
| 103 Private slot called, when the the project menu or a submenu is | 103 Private slot called, when the the project menu or a submenu is |
| 104 about to be shown. | 104 about to be shown. |
| 105 </p><dl> | 105 </p><dl> |
| 106 <dt><i>menuName</i></dt> | 106 <dt><i>menuName</i></dt> |
| 107 <dd> | 107 <dd> |
| 108 name of the menu to be shown (string) | 108 name of the menu to be shown (string) |
| 109 </dd><dt><i>menu</i></dt> | 109 </dd><dt><i>menu</i></dt> |
| 110 <dd> | 110 <dd> |
| 111 reference to the menu (QMenu) | 111 reference to the menu (QMenu) |
| 112 </dd> | 112 </dd> |
| 113 </dl><a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> | 113 </dl><a NAME="EricdocPlugin.activate" ID="EricdocPlugin.activate"></a> |
| 114 <h4>EricdocPlugin.activate</h4> | 114 <h4>EricdocPlugin.activate</h4> |
| 115 <b>activate</b>(<i></i>) | 115 <b>activate</b>(<i></i>) |
| 116 <p> | 116 <p> |
| 117 Public method to activate this plugin. | 117 Public method to activate this plugin. |
| 118 </p><dl> | 118 </p><dl> |
| 119 <dt>Returns:</dt> | 119 <dt>Returns:</dt> |
| 120 <dd> | 120 <dd> |
| 121 tuple of None and activation status (boolean) | 121 tuple of None and activation status (boolean) |
| 122 </dd> | 122 </dd> |
| 123 </dl><a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> | 123 </dl><a NAME="EricdocPlugin.deactivate" ID="EricdocPlugin.deactivate"></a> |
| 124 <h4>EricdocPlugin.deactivate</h4> | 124 <h4>EricdocPlugin.deactivate</h4> |
| 125 <b>deactivate</b>(<i></i>) | 125 <b>deactivate</b>(<i></i>) |
| 126 <p> | 126 <p> |
| 127 Public method to deactivate this plugin. | 127 Public method to deactivate this plugin. |
| 128 </p> | 128 </p> |
| 129 <div align="right"><a href="#top">Up</a></div> | 129 <div align="right"><a href="#top">Up</a></div> |
| 130 <hr /><hr /> | 130 <hr /><hr /> |
| 131 <a NAME="exeDisplayData" ID="exeDisplayData"></a> | 131 <a NAME="exeDisplayData" ID="exeDisplayData"></a> |
| 132 <h2>exeDisplayData</h2> | 132 <h2>exeDisplayData</h2> |
| 133 <b>exeDisplayData</b>(<i></i>) | 133 <b>exeDisplayData</b>(<i></i>) |
| 134 <p> | 134 <p> |
| 135 Public method to support the display of some executable info. | 135 Public method to support the display of some executable info. |
| 136 </p><dl> | 136 </p><dl> |
| 137 <dt>Returns:</dt> | 137 <dt>Returns:</dt> |
| 138 <dd> | 138 <dd> |
| 139 dictionary containing the data to query the presence of | 139 dictionary containing the data to query the presence of |
| 140 the executable | 140 the executable |
| 141 </dd> | 141 </dd> |
| 142 </dl> | 142 </dl> |
| 143 <div align="right"><a href="#top">Up</a></div> | 143 <div align="right"><a href="#top">Up</a></div> |
| 144 <hr /> | 144 <hr /> |
| 145 </body></html> | 145 </body></html> |
