--- a/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.DocumentationPlugins.Ericapi.EricapiConfigDialog</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; &#101;&#110;&#116;&#101;&#114; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#102;&#111;&#114; &#101;&#114;&#105;&#99;&#53;-&#97;&#112;&#105;.
+Module implementing a dialog to enter the parameters for eric5-api.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#EricapiConfigDialog">EricapiConfigDialog</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; &#101;&#110;&#116;&#101;&#114; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#102;&#111;&#114; &#101;&#114;&#105;&#99;&#53;-&#97;&#112;&#105;.</td>
+<td>Class implementing a dialog to enter the parameters for eric5-api.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="EricapiConfigDialog" ID="EricapiConfigDialog"></a>
 <h2>EricapiConfigDialog</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; &#101;&#110;&#116;&#101;&#114; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#102;&#111;&#114; &#101;&#114;&#105;&#99;&#53;-&#97;&#112;&#105;.
+    Class implementing a dialog to enter the parameters for eric5-api.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_EricapiConfigDialog
@@ -55,119 +55,119 @@
 <table>
 <tr>
 <td><a href="#EricapiConfigDialog.__init__">EricapiConfigDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; v&#97;&#108;&#117;&#101;&#115;.</td>
+<td>Private method to set the default values.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.accept">accept</a></td>
-<td>&#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#79;&#107; &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Protected slot called by the Ok button.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.generateParameters">generateParameters</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#115; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.</td>
+<td>Public method that generates the commandline parameters.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.on_addButton_clicked">on_addButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#97;&#100;&#100; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#108;&#105;&#115;&#116;v&#105;&#101;w.</td>
+<td>Private slot to add the directory displayed to the listview.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#101;&#108;&#101;&#116;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116;&#108;y &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#108;&#105;&#115;&#116;&#98;&#111;x.</td>
+<td>Private slot to delete the currently selected directory of the listbox.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.on_ignoreDirButton_clicked">on_ignoreDirButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#98;&#101; &#105;&#103;&#110;&#111;&#114;&#101;&#100;.</td>
+<td>Private slot to select a directory to be ignored.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.on_outputFileButton_clicked">on_outputFileButton_clicked</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#102;&#105;&#108;&#101;.</td>
+<td>Private slot to select the output file.</td>
 </tr><tr>
 <td><a href="#EricapiConfigDialog.on_outputFileEdit_textChanged">on_outputFileEdit_textChanged</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101;/&#100;&#105;&#115;&#97;&#98;&#108;&#101; &#116;&#104;&#101; "&#79;&#75;" &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Private slot to enable/disable the "OK" button.</td>
 </tr>
 </table>
 <a NAME="EricapiConfigDialog.__init__" ID="EricapiConfigDialog.__init__"></a>
 <h4>EricapiConfigDialog (Constructor)</h4>
 <b>EricapiConfigDialog</b>(<i>project, parms = None, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>project</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#111;&#98;&#106;&#101;&#99;&#116; (&#80;&#114;&#111;&#106;&#101;&#99;&#116;.&#80;&#114;&#111;&#106;&#101;&#99;&#116;)
+reference to the project object (Project.Project)
 </dd><dt><i>parms</i></dt>
 <dd>
-&#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#116;&#111; &#115;&#101;&#116; &#105;&#110; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;
+parameters to set in the dialog
 </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;
+parent widget of this dialog
 </dd>
 </dl><a NAME="EricapiConfigDialog.__initializeDefaults" ID="EricapiConfigDialog.__initializeDefaults"></a>
 <h4>EricapiConfigDialog.__initializeDefaults</h4>
 <b>__initializeDefaults</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; v&#97;&#108;&#117;&#101;&#115;. 
+        Private method to set the default values. 
 </p><p>
-        &#84;&#104;&#101;&#115;&#101; &#97;&#114;&#101; &#110;&#101;&#101;&#100;&#101;&#100; &#108;&#97;&#116;&#101;&#114; &#111;&#110; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101;
-        &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.
+        These are needed later on to generate the commandline
+        parameters.
 </p><a NAME="EricapiConfigDialog.accept" ID="EricapiConfigDialog.accept"></a>
 <h4>EricapiConfigDialog.accept</h4>
 <b>accept</b>(<i></i>)
 <p>
-        &#80;&#114;&#111;&#116;&#101;&#99;&#116;&#101;&#100; &#115;&#108;&#111;&#116; &#99;&#97;&#108;&#108;&#101;&#100; &#98;y &#116;&#104;&#101; &#79;&#107; &#98;&#117;&#116;&#116;&#111;&#110;. 
+        Protected slot called by the Ok button. 
 </p><p>
-        &#73;&#116; &#115;&#97;v&#101;&#115; &#116;&#104;&#101; v&#97;&#108;&#117;&#101;&#115; &#105;&#110; &#116;&#104;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y.
+        It saves the values in the parameters dictionary.
 </p><a NAME="EricapiConfigDialog.generateParameters" ID="EricapiConfigDialog.generateParameters"></a>
 <h4>EricapiConfigDialog.generateParameters</h4>
 <b>generateParameters</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#104;&#97;&#116; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#115; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;.
+        Public method that generates the commandline parameters.
 </p><p>
-        &#73;&#116; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#115; &#97; &#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100;
-        &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#81;&#80;&#114;&#111;&#99;&#101;&#115;&#115; &#97;&#114;&#103;&#117;&#109;&#101;&#110;&#116;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#101;&#114;&#105;&#99;&#97;&#112;&#105; &#99;&#97;&#108;&#108; &#97;&#110;&#100;
-        &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#111;&#110; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;. &#84;&#104;&#105;&#115;
-        &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#97;&#110; &#98;&#101; &#112;&#97;&#115;&#115;&#101;&#100; &#98;&#97;&#99;&#107; &#117;&#112;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#105;&#111;&#110; &#116;&#111; &#111;v&#101;&#114;w&#114;&#105;&#116;&#101;
-        &#116;&#104;&#101; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+        It generates a list of strings to be used
+        to set the QProcess arguments for the ericapi call and
+        a dictionary containing the non default parameters. This
+        dictionary can be passed back upon object generation to overwrite
+        the default settings.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#97; &#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#109;&#109;&#97;&#110;&#100;&#108;&#105;&#110;&#101; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115; &#97;&#110;&#100; &#110;&#111;&#110; &#100;&#101;&#102;&#97;&#117;&#108;&#116; &#112;&#97;&#114;&#97;&#109;&#101;&#116;&#101;&#114;&#115;
-            (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;, &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y)
+a tuple of the commandline parameters and non default parameters
+            (list of strings, dictionary)
 </dd>
 </dl><a NAME="EricapiConfigDialog.on_addButton_clicked" ID="EricapiConfigDialog.on_addButton_clicked"></a>
 <h4>EricapiConfigDialog.on_addButton_clicked</h4>
 <b>on_addButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#97;&#100;&#100; &#116;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#100;&#105;&#115;&#112;&#108;&#97;y&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#108;&#105;&#115;&#116;v&#105;&#101;w.
+        Private slot to add the directory displayed to the listview.
 </p><p>
-        &#84;&#104;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#105;&#110; &#116;&#104;&#101; &#105;&#103;&#110;&#111;&#114;&#101; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;&#105;&#101;&#115;
-        &#108;&#105;&#110;&#101; &#101;&#100;&#105;&#116; &#105;&#115; &#109;&#111;v&#101;&#100; &#116;&#111; &#116;&#104;&#101; &#108;&#105;&#115;&#116;&#98;&#111;x &#97;&#98;&#111;v&#101; &#97;&#110;&#100; &#116;&#104;&#101; &#101;&#100;&#105;&#116; &#105;&#115; &#99;&#108;&#101;&#97;&#114;&#101;&#100;.
+        The directory in the ignore directories
+        line edit is moved to the listbox above and the edit is cleared.
 </p><a NAME="EricapiConfigDialog.on_deleteButton_clicked" ID="EricapiConfigDialog.on_deleteButton_clicked"></a>
 <h4>EricapiConfigDialog.on_deleteButton_clicked</h4>
 <b>on_deleteButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#100;&#101;&#108;&#101;&#116;&#101; &#116;&#104;&#101; &#99;&#117;&#114;&#114;&#101;&#110;&#116;&#108;y &#115;&#101;&#108;&#101;&#99;&#116;&#101;&#100; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#111;&#102; &#116;&#104;&#101; &#108;&#105;&#115;&#116;&#98;&#111;x.
+        Private slot to delete the currently selected directory of the listbox.
 </p><a NAME="EricapiConfigDialog.on_ignoreDirButton_clicked" ID="EricapiConfigDialog.on_ignoreDirButton_clicked"></a>
 <h4>EricapiConfigDialog.on_ignoreDirButton_clicked</h4>
 <b>on_ignoreDirButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#98;&#101; &#105;&#103;&#110;&#111;&#114;&#101;&#100;.
+        Private slot to select a directory to be ignored.
 </p><p>
-        &#73;&#116; &#100;&#105;&#115;&#112;&#108;&#97;y&#115; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111;
-        &#115;&#101;&#108;&#101;&#99;&#116; &#97; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#116;&#111; &#98;&#101; &#105;&#103;&#110;&#111;&#114;&#101;&#100;.
+        It displays a directory selection dialog to
+        select a directory to be ignored.
 </p><a NAME="EricapiConfigDialog.on_outputFileButton_clicked" ID="EricapiConfigDialog.on_outputFileButton_clicked"></a>
 <h4>EricapiConfigDialog.on_outputFileButton_clicked</h4>
 <b>on_outputFileButton_clicked</b>(<i></i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#101;&#108;&#101;&#99;&#116; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#102;&#105;&#108;&#101;.
+        Private slot to select the output file.
 </p><p>
-        &#73;&#116; &#100;&#105;&#115;&#112;&#108;&#97;y&#115; &#97; &#102;&#105;&#108;&#101; &#115;&#101;&#108;&#101;&#99;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111;
-        &#115;&#101;&#108;&#101;&#99;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#116;&#104;&#101; &#97;&#112;&#105; &#105;&#115; w&#114;&#105;&#116;&#116;&#101;&#110; &#116;&#111;.
+        It displays a file selection dialog to
+        select the file the api is written to.
 </p><a NAME="EricapiConfigDialog.on_outputFileEdit_textChanged" ID="EricapiConfigDialog.on_outputFileEdit_textChanged"></a>
 <h4>EricapiConfigDialog.on_outputFileEdit_textChanged</h4>
 <b>on_outputFileEdit_textChanged</b>(<i>filename</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#101;&#110;&#97;&#98;&#108;&#101;/&#100;&#105;&#115;&#97;&#98;&#108;&#101; &#116;&#104;&#101; "&#79;&#75;" &#98;&#117;&#116;&#116;&#111;&#110;.
+        Private slot to enable/disable the "OK" button.
 </p><dl>
 <dt><i>filename</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the file (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>