Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html

Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html
--- a/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.DocumentationPlugins.Ericdoc.EricdocExecDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+Module implementing a dialog to show the output of the ericdoc process.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#EricdocExecDialog">EricdocExecDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.</td>
+<td>Class implementing a dialog to show the output of the ericdoc process.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,10 +43,10 @@
 <a NAME="EricdocExecDialog" ID="EricdocExecDialog"></a>
 <h2>EricdocExecDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+    Class implementing a dialog to show the output of the ericdoc process.
 </p><p>
-    &#84;&#104;&#105;&#115; &#99;&#108;&#97;&#115;&#115; &#115;&#116;&#97;&#114;&#116;&#115; &#97; &#81;&#80;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#100;&#105;&#115;&#112;&#108;&#97;y&#115; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#104;&#97;&#116;
-    &#115;&#104;&#111;w&#115; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+    This class starts a QProcess and displays a dialog that
+    shows the output of the documentation command process.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_EricdocExecDialog
@@ -58,88 +58,88 @@
 <table>
 <tr>
 <td><a href="#EricdocExecDialog.__init__">EricdocExecDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#EricdocExecDialog.__finish">__finish</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; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100;.</td>
+<td>Private slot called when the process finished.</td>
 </tr><tr>
 <td><a href="#EricdocExecDialog.__readStderr">__readStderr</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;.</td>
+<td>Private slot to handle the readyReadStandardError signal.</td>
 </tr><tr>
 <td><a href="#EricdocExecDialog.__readStdout">__readStdout</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;.</td>
+<td>Private slot to handle the readyReadStandardOutput signal.</td>
 </tr><tr>
 <td><a href="#EricdocExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.</td>
+<td>Private slot called by a button of the button box clicked.</td>
 </tr><tr>
 <td><a href="#EricdocExecDialog.start">start</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td>
+<td>Public slot to start the ericdoc command.</td>
 </tr>
 </table>
 <a NAME="EricdocExecDialog.__init__" ID="EricdocExecDialog.__init__"></a>
 <h4>EricdocExecDialog (Constructor)</h4>
 <b>EricdocExecDialog</b>(<i>cmdname, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>cmdname</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the documentation generator (string)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#105;&#115; &#100;&#105;&#97;&#108;&#111;&#103; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget of this dialog (QWidget)
 </dd>
 </dl><a NAME="EricdocExecDialog.__finish" ID="EricdocExecDialog.__finish"></a>
 <h4>EricdocExecDialog.__finish</h4>
 <b>__finish</b>(<i></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; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100;.
+        Private slot called when the process finished.
 </p><p>
-        &#73;&#116; &#105;&#115; &#99;&#97;&#108;&#108;&#101;&#100; w&#104;&#101;&#110; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#102;&#105;&#110;&#105;&#115;&#104;&#101;&#100; &#111;&#114;
-        &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.
+        It is called when the process finished or
+        the user pressed the button.
 </p><a NAME="EricdocExecDialog.__readStderr" ID="EricdocExecDialog.__readStderr"></a>
 <h4>EricdocExecDialog.__readStderr</h4>
 <b>__readStderr</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#69;&#114;&#114;&#111;&#114; &#115;&#105;&#103;&#110;&#97;&#108;. 
+        Private slot to handle the readyReadStandardError signal. 
 </p><p>
-        &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#101;&#114;&#114;&#111;&#114; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111; &#116;&#104;&#101;
-        &#101;&#114;&#114;&#111;&#114; &#112;&#97;&#110;&#101;.
+        It reads the error output of the process and inserts it into the
+        error pane.
 </p><a NAME="EricdocExecDialog.__readStdout" ID="EricdocExecDialog.__readStdout"></a>
 <h4>EricdocExecDialog.__readStdout</h4>
 <b>__readStdout</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#104;&#97;&#110;&#100;&#108;&#101; &#116;&#104;&#101; &#114;&#101;&#97;&#100;y&#82;&#101;&#97;&#100;&#83;&#116;&#97;&#110;&#100;&#97;&#114;&#100;&#79;&#117;&#116;&#112;&#117;&#116; &#115;&#105;&#103;&#110;&#97;&#108;. 
+        Private slot to handle the readyReadStandardOutput signal. 
 </p><p>
-        &#73;&#116; &#114;&#101;&#97;&#100;&#115; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115;, &#102;&#111;&#114;&#109;&#97;&#116;&#115; &#105;&#116; &#97;&#110;&#100; &#105;&#110;&#115;&#101;&#114;&#116;&#115; &#105;&#116; &#105;&#110;&#116;&#111;
-        &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.
+        It reads the output of the process, formats it and inserts it into
+        the contents pane.
 </p><a NAME="EricdocExecDialog.on_buttonBox_clicked" ID="EricdocExecDialog.on_buttonBox_clicked"></a>
 <h4>EricdocExecDialog.on_buttonBox_clicked</h4>
 <b>on_buttonBox_clicked</b>(<i>button</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#97; &#98;&#117;&#116;&#116;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#98;&#111;x &#99;&#108;&#105;&#99;&#107;&#101;&#100;.
+        Private slot called by a button of the button box clicked.
 </p><dl>
 <dt><i>button</i></dt>
 <dd>
-&#98;&#117;&#116;&#116;&#111;&#110; &#116;&#104;&#97;&#116; w&#97;&#115; &#99;&#108;&#105;&#99;&#107;&#101;&#100; (&#81;&#65;&#98;&#115;&#116;&#114;&#97;&#99;&#116;&#66;&#117;&#116;&#116;&#111;&#110;)
+button that was clicked (QAbstractButton)
 </dd>
 </dl><a NAME="EricdocExecDialog.start" ID="EricdocExecDialog.start"></a>
 <h4>EricdocExecDialog.start</h4>
 <b>start</b>(<i>args, fn</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.
+        Public slot to start the ericdoc command.
 </p><dl>
 <dt><i>args</i></dt>
 <dd>
-&#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115; &#102;&#111;&#114; &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+commandline arguments for ericdoc program (list of strings)
 </dd><dt><i>fn</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#114; &#100;&#105;&#114;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115;&#101;&#100; &#98;y &#101;&#114;&#105;&#99;&#100;&#111;&#99; &#112;&#114;&#111;&#103;&#114;&#97;&#109; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename or dirname to be processed by ericdoc program (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#115;&#117;&#99;&#99;&#101;&#115;&#115;&#102;&#117;&#108; &#115;&#116;&#97;&#114;&#116; &#111;&#102; &#116;&#104;&#101; &#112;&#114;&#111;&#99;&#101;&#115;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the successful start of the process (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial