--- a/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</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; &#115;v&#110; &#100;&#105;&#102;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100; &#112;&#114;&#111;&#99;&#101;&#115;&#115;.
+Module implementing a dialog to show the output of the svn diff command process.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#SvnDiffDialog">SvnDiffDialog</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; &#115;v&#110; &#100;&#105;&#102;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td>
+<td>Class implementing a dialog to show the output of the svn diff command.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a>
 <h2>SvnDiffDialog</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; &#115;v&#110; &#100;&#105;&#102;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.
+    Class implementing a dialog to show the output of the svn diff command.
 </p>
 <h3>Derived from</h3>
 QWidget, SvnDialogMixin, Ui_SvnDiffDialog
@@ -55,141 +55,141 @@
 <table>
 <tr>
 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#112;&#112;&#101;&#110;&#100; &#116;&#101;x&#116; &#116;&#111; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.</td>
+<td>Private method to append text to the end of the contents pane.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.__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; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.</td>
+<td>Private slot called when the user pressed the button.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#102;&#102; &#115;&#117;&#109;&#109;&#97;&#114;y.</td>
+<td>Private method to get a string descripion of the diff summary.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#112;y&#115;v&#110; &#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#110;&#117;&#109;&#98;&#101;&#114;.</td>
+<td>Private method to get a pysvn revision object for the given version number.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.__showError">__showError</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#97;&#110; &#101;&#114;&#114;&#111;&#114; &#109;&#101;&#115;&#115;&#97;&#103;&#101;.</td>
+<td>Private slot to show an error message.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.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="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</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; &#83;&#97;v&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.</td>
+<td>Private slot to handle the Save button press.</td>
 </tr><tr>
 <td><a href="#SvnDiffDialog.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; &#115;v&#110; &#100;&#105;&#102;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.</td>
+<td>Public slot to start the svn diff command.</td>
 </tr>
 </table>
 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
 <h4>SvnDiffDialog (Constructor)</h4>
 <b>SvnDiffDialog</b>(<i>vcs, parent = None</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>vcs</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; v&#99;&#115; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the vcs object
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget (QWidget)
 </dd>
 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
 <h4>SvnDiffDialog.__appendText</h4>
 <b>__appendText</b>(<i>line</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#112;&#112;&#101;&#110;&#100; &#116;&#101;x&#116; &#116;&#111; &#116;&#104;&#101; &#101;&#110;&#100; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#116;&#101;&#110;&#116;&#115; &#112;&#97;&#110;&#101;.
+        Private method to append text to the end of the contents pane.
 </p><dl>
 <dt><i>line</i></dt>
 <dd>
-&#108;&#105;&#110;&#101; &#111;&#102; &#116;&#101;x&#116; &#116;&#111; &#105;&#110;&#115;&#101;&#114;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+line of text to insert (string)
 </dd>
 </dl><a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a>
 <h4>SvnDiffDialog.__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; &#117;&#115;&#101;&#114; &#112;&#114;&#101;&#115;&#115;&#101;&#100; &#116;&#104;&#101; &#98;&#117;&#116;&#116;&#111;&#110;.
+        Private slot called when the user pressed the button.
 </p><a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a>
 <h4>SvnDiffDialog.__getDiffSummaryKind</h4>
 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#115;&#116;&#114;&#105;&#110;&#103; &#100;&#101;&#115;&#99;&#114;&#105;&#112;&#105;&#111;&#110; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#102;&#102; &#115;&#117;&#109;&#109;&#97;&#114;y.
+        Private method to get a string descripion of the diff summary.
 </p><dl>
 <dt><i>summaryKind</i></dt>
 <dd>
-(&#112;y&#115;v&#110;.&#100;&#105;&#102;&#102;&#95;&#115;&#117;&#109;&#109;&#97;&#114;&#105;z&#101;.&#115;&#117;&#109;&#109;&#97;&#114;&#105;z&#101;&#95;&#107;&#105;&#110;&#100;)
+(pysvn.diff_summarize.summarize_kind)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#111;&#110;&#101; &#108;&#101;&#116;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#99;&#104;&#97;&#110;&#103;&#101; &#116;y&#112;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+one letter string indicating the change type (string)
 </dd>
 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
 <h4>SvnDiffDialog.__getVersionArg</h4>
 <b>__getVersionArg</b>(<i>version</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#112;y&#115;v&#110; &#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#105;v&#101;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#110;&#117;&#109;&#98;&#101;&#114;.
+        Private method to get a pysvn revision object for the given version number.
 </p><dl>
 <dt><i>version</i></dt>
 <dd>
-&#114;&#101;v&#105;&#115;&#105;&#111;&#110; (&#105;&#110;&#116;&#101;&#103;&#101;&#114; &#111;&#114; &#115;&#116;&#114;&#105;&#110;&#103;)
+revision (integer or string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#111;&#98;&#106;&#101;&#99;&#116; (&#112;y&#115;v&#110;.&#82;&#101;v&#105;&#115;&#105;&#111;&#110;)
+revision object (pysvn.Revision)
 </dd>
 </dl><a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a>
 <h4>SvnDiffDialog.__showError</h4>
 <b>__showError</b>(<i>msg</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#104;&#111;w &#97;&#110; &#101;&#114;&#114;&#111;&#114; &#109;&#101;&#115;&#115;&#97;&#103;&#101;.
+        Private slot to show an error message.
 </p><dl>
 <dt><i>msg</i></dt>
 <dd>
-&#101;&#114;&#114;&#111;&#114; &#109;&#101;&#115;&#115;&#97;&#103;&#101; &#116;&#111; &#115;&#104;&#111;w (&#115;&#116;&#114;&#105;&#110;&#103;)
+error message to show (string)
 </dd>
 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
 <h4>SvnDiffDialog.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="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
 <b>on_saveButton_clicked</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; &#83;&#97;v&#101; &#98;&#117;&#116;&#116;&#111;&#110; &#112;&#114;&#101;&#115;&#115;.
+        Private slot to handle the Save button press.
 </p><p>
-        &#73;&#116; &#115;&#97;v&#101;&#115; &#116;&#104;&#101; &#100;&#105;&#102;&#102; &#115;&#104;&#111;w&#110; &#105;&#110; &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103; &#116;&#111; &#97; &#102;&#105;&#108;&#101; &#105;&#110; &#116;&#104;&#101; &#108;&#111;&#99;&#97;&#108;
-        &#102;&#105;&#108;&#101;&#115;y&#115;&#116;&#101;&#109;.
+        It saves the diff shown in the dialog to a file in the local
+        filesystem.
 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
 <h4>SvnDiffDialog.start</h4>
 <b>start</b>(<i>fn, versions = None, urls = None, summary = False, pegRev = None</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#115;&#108;&#111;&#116; &#116;&#111; &#115;&#116;&#97;&#114;&#116; &#116;&#104;&#101; &#115;v&#110; &#100;&#105;&#102;&#102; &#99;&#111;&#109;&#109;&#97;&#110;&#100;.
+        Public slot to start the svn diff command.
 </p><dl>
 <dt><i>fn</i></dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#100;&#105;&#102;&#102;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename to be diffed (string)
 </dd><dt><i>versions</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; v&#101;&#114;&#115;&#105;&#111;&#110;&#115; &#116;&#111; &#98;&#101; &#100;&#105;&#102;&#102;&#101;&#100; (&#108;&#105;&#115;&#116; &#111;&#102; &#117;&#112; &#116;&#111; &#50; &#105;&#110;&#116;&#101;&#103;&#101;&#114; &#111;&#114; &#78;&#111;&#110;&#101;)
+list of versions to be diffed (list of up to 2 integer or None)
 </dd><dt><i>urls=</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#114;&#101;&#112;&#111;&#115;&#105;&#116;&#111;&#114;y &#85;&#82;&#76;&#115; (&#108;&#105;&#115;&#116; &#111;&#102; &#50; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of repository URLs (list of 2 strings)
 </dd><dt><i>summary=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#115;&#117;&#109;&#109;&#97;&#114;&#105;z&#105;&#110;&#103; &#100;&#105;&#102;&#102;
-            (&#111;&#110;&#108;y v&#97;&#108;&#105;&#100; &#102;&#111;&#114; &#85;&#82;&#76; &#100;&#105;&#102;&#102;&#115;) (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating a summarizing diff
+            (only valid for URL diffs) (boolean)
 </dd><dt><i>pegRev=</i></dt>
 <dd>
-&#114;&#101;v&#105;&#115;&#105;&#111;&#110; &#110;&#117;&#109;&#98;&#101;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#115; v&#97;&#108;&#105;&#100; (&#105;&#110;&#116;&#101;&#103;&#101;&#114;)
+revision number the filename is valid (integer)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>