eric: diff Documentation/Source/eric5.UI.AuthenticationDialog.html

diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.UI.AuthenticationDialog.html
--- a/Documentation/Source/eric5.UI.AuthenticationDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.UI.AuthenticationDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.UI.AuthenticationDialog</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;.
+Module implementing the authentication dialog for the help browser.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#AuthenticationDialog">AuthenticationDialog</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;.</td>
+<td>Class implementing the authentication dialog for the help browser.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="AuthenticationDialog" ID="AuthenticationDialog"></a>
 <h2>AuthenticationDialog</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#97;&#117;&#116;&#104;&#101;&#110;&#116;&#105;&#99;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103; &#102;&#111;&#114; &#116;&#104;&#101; &#104;&#101;&#108;&#112; &#98;&#114;&#111;w&#115;&#101;&#114;.
+    Class implementing the authentication dialog for the help browser.
 </p>
 <h3>Derived from</h3>
 QDialog, Ui_AuthenticationDialog
@@ -55,69 +55,69 @@
 <table>
 <tr>
 <td><a href="#AuthenticationDialog.__init__">AuthenticationDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#AuthenticationDialog.getData">getData</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.</td>
+<td>Public method to retrieve the login data.</td>
 </tr><tr>
 <td><a href="#AuthenticationDialog.setData">setData</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.</td>
+<td>Public method to set the login data.</td>
 </tr><tr>
 <td><a href="#AuthenticationDialog.shallSave">shallSave</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100;.</td>
+<td>Public method to check, if the login data shall be saved.</td>
 </tr>
 </table>
 <a NAME="AuthenticationDialog.__init__" ID="AuthenticationDialog.__init__"></a>
 <h4>AuthenticationDialog (Constructor)</h4>
 <b>AuthenticationDialog</b>(<i>info, username, showSave = False, saveIt = False, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>info</i></dt>
 <dd>
-&#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+information to be shown (string)
 </dd><dt><i>username</i></dt>
 <dd>
-&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; &#97;&#115; &#115;&#117;&#112;&#112;&#108;&#105;&#101;&#100; &#98;y &#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+username as supplied by subversion (string)
 </dd><dt><i>showSave</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#116;&#111; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#101; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#115;&#97;v&#101; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag to indicate to show the save checkbox (boolean)
 </dd><dt><i>saveIt</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#102;&#111;&#114; &#116;&#104;&#101; &#115;&#97;v&#101; &#99;&#104;&#101;&#99;&#107;&#98;&#111;x (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating the value for the save checkbox (boolean)
 </dd>
 </dl><a NAME="AuthenticationDialog.getData" ID="AuthenticationDialog.getData"></a>
 <h4>AuthenticationDialog.getData</h4>
 <b>getData</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.
+        Public method to retrieve the login data.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#116;w&#111; &#115;&#116;&#114;&#105;&#110;&#103; v&#97;&#108;&#117;&#101;&#115; (&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101;, &#112;&#97;&#115;&#115;w&#111;&#114;&#100;)
+tuple of two string values (username, password)
 </dd>
 </dl><a NAME="AuthenticationDialog.setData" ID="AuthenticationDialog.setData"></a>
 <h4>AuthenticationDialog.setData</h4>
 <b>setData</b>(<i>username, password</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97;.
+        Public method to set the login data.
 </p><dl>
 <dt><i>username</i></dt>
 <dd>
-&#117;&#115;&#101;&#114;&#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+username (string)
 </dd><dt><i>password</i></dt>
 <dd>
-&#112;&#97;&#115;&#115;w&#111;&#114;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+password (string)
 </dd>
 </dl><a NAME="AuthenticationDialog.shallSave" ID="AuthenticationDialog.shallSave"></a>
 <h4>AuthenticationDialog.shallSave</h4>
 <b>shallSave</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100;.
+        Public method to check, if the login data shall be saved.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#97;&#116; &#116;&#104;&#101; &#108;&#111;&#103;&#105;&#110; &#100;&#97;&#116;&#97; &#115;&#104;&#97;&#108;&#108; &#98;&#101; &#115;&#97;v&#101;&#100; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating that the login data shall be saved (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>