eric: diff Documentation/Source/eric5.Plugins.PluginEricapi.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Plugins.PluginEricapi.html
--- a/Documentation/Source/eric5.Plugins.PluginEricapi.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.PluginEricapi.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.PluginEricapi</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#69;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#108;&#117;&#103;&#105;&#110;.
+Module implementing the Ericapi plugin.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,21 +32,21 @@
 <table>
 <tr>
 <td><a href="#EricapiPlugin">EricapiPlugin</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#69;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Class implementing the Ericapi plugin.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr>
 <td><a href="#exeDisplayData">exeDisplayData</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;.</td>
+<td>Public method to support the display of some executable info.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="EricapiPlugin" ID="EricapiPlugin"></a>
 <h2>EricapiPlugin</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#69;&#114;&#105;&#99;&#97;&#112;&#105; &#112;&#108;&#117;&#103;&#105;&#110;.
+    Class implementing the Ericapi plugin.
 </p>
 <h3>Derived from</h3>
 QObject
@@ -58,73 +58,73 @@
 <table>
 <tr>
 <td><a href="#EricapiPlugin.__init__">EricapiPlugin</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#EricapiPlugin.__doEricapi">__doEricapi</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53;-&#97;&#112;&#105; &#97;&#112;&#105; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Private slot to perform the eric5-api api generation.</td>
 </tr><tr>
 <td><a href="#EricapiPlugin.__initialize">__initialize</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; (&#114;&#101;)&#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Private slot to (re)initialize the plugin.</td>
 </tr><tr>
 <td><a href="#EricapiPlugin.__projectShowMenu">__projectShowMenu</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115; &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.</td>
+<td>Private slot called, when the the project menu or a submenu is about to be shown.</td>
 </tr><tr>
 <td><a href="#EricapiPlugin.activate">activate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to activate this plugin.</td>
 </tr><tr>
 <td><a href="#EricapiPlugin.deactivate">deactivate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to deactivate this plugin.</td>
 </tr>
 </table>
 <a NAME="EricapiPlugin.__init__" ID="EricapiPlugin.__init__"></a>
 <h4>EricapiPlugin (Constructor)</h4>
 <b>EricapiPlugin</b>(<i>ui</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>ui</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#85;&#73;.&#85;&#115;&#101;&#114;&#73;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;)
+reference to the user interface object (UI.UserInterface)
 </dd>
 </dl><a NAME="EricapiPlugin.__doEricapi" ID="EricapiPlugin.__doEricapi"></a>
 <h4>EricapiPlugin.__doEricapi</h4>
 <b>__doEricapi</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#112;&#101;&#114;&#102;&#111;&#114;&#109; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#53;-&#97;&#112;&#105; &#97;&#112;&#105; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110;.
+        Private slot to perform the eric5-api api generation.
 </p><a NAME="EricapiPlugin.__initialize" ID="EricapiPlugin.__initialize"></a>
 <h4>EricapiPlugin.__initialize</h4>
 <b>__initialize</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; (&#114;&#101;)&#105;&#110;&#105;&#116;&#105;&#97;&#108;&#105;z&#101; &#116;&#104;&#101; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Private slot to (re)initialize the plugin.
 </p><a NAME="EricapiPlugin.__projectShowMenu" ID="EricapiPlugin.__projectShowMenu"></a>
 <h4>EricapiPlugin.__projectShowMenu</h4>
 <b>__projectShowMenu</b>(<i>menuName, menu</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100;, w&#104;&#101;&#110; &#116;&#104;&#101; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#109;&#101;&#110;&#117; &#111;&#114; &#97; &#115;&#117;&#98;&#109;&#101;&#110;&#117; &#105;&#115;
-        &#97;&#98;&#111;&#117;&#116; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110;.
+        Private slot called, when the the project menu or a submenu is
+        about to be shown.
 </p><dl>
 <dt><i>menuName</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#109;&#101;&#110;&#117; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the menu to be shown (string)
 </dd><dt><i>menu</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#109;&#101;&#110;&#117; (&#81;&#77;&#101;&#110;&#117;)
+reference to the menu (QMenu)
 </dd>
 </dl><a NAME="EricapiPlugin.activate" ID="EricapiPlugin.activate"></a>
 <h4>EricapiPlugin.activate</h4>
 <b>activate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to activate this plugin.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#78;&#111;&#110;&#101; &#97;&#110;&#100; &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+tuple of None and activation status (boolean)
 </dd>
 </dl><a NAME="EricapiPlugin.deactivate" ID="EricapiPlugin.deactivate"></a>
 <h4>EricapiPlugin.deactivate</h4>
 <b>deactivate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to deactivate this plugin.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
@@ -132,12 +132,12 @@
 <h2>exeDisplayData</h2>
 <b>exeDisplayData</b>(<i></i>)
 <p>
-    &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;.
+    Public method to support the display of some executable info.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#97;&#116;&#97; &#116;&#111; &#113;&#117;&#101;&#114;y &#116;&#104;&#101; &#112;&#114;&#101;&#115;&#101;&#110;&#99;&#101; &#111;&#102;
-        &#116;&#104;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101;
+dictionary containing the data to query the presence of
+        the executable
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>