src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffGenerator.html	Sat Dec 23 15:40:23 2023 +0100
@@ -110,13 +110,13 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
 reference to the vcs object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (QWidget)
+parent widget
 </dd>
 </dl>
 <a NAME="HgDiffGenerator.__extractFileName" ID="HgDiffGenerator.__extractFileName"></a>
@@ -128,15 +128,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-line to be processed (string)
+line to be processed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-extracted file name (string)
+extracted file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="HgDiffGenerator.__finish" ID="HgDiffGenerator.__finish"></a>
@@ -156,15 +162,21 @@
 </p>
 <dl>
 
-<dt><i>version</i></dt>
+<dt><i>version</i> (int or str)</dt>
 <dd>
-revision (integer or string)
+revision
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-version argument (string)
+version argument
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="HgDiffGenerator.__processFileLine" ID="HgDiffGenerator.__processFileLine"></a>
@@ -195,9 +207,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of lists of string containing lines of the diff, the
-            list of errors and a list of tuples of filenames and the line
-            into the diff output.
+tuple containing a list of lines of the diff, a list of errors
+            and a list of tuples of filenames and the line into the diff output
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, list of str, list of tuple of (str, int))
 </dd>
 </dl>
 <a NAME="HgDiffGenerator.start" ID="HgDiffGenerator.start"></a>
@@ -209,29 +226,33 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename to be diffed (string)
+filename to be diffed
 </dd>
-<dt><i>versions</i></dt>
+<dt><i>versions</i> (list of up to 2 str or None)</dt>
 <dd>
-list of versions to be diffed (list of up to
-            2 strings or None)
+list of versions to be diffed
 </dd>
-<dt><i>bundle</i></dt>
+<dt><i>bundle</i> (str)</dt>
 <dd>
-name of a bundle file (string)
+name of a bundle file
 </dd>
-<dt><i>qdiff</i></dt>
+<dt><i>qdiff</i> (bool)</dt>
 <dd>
-flag indicating qdiff command shall be used (boolean)
+flag indicating qdiff command shall be used
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 flag indicating a successful start of the diff command
-            (boolean)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="HgDiffGenerator.stopProcess" ID="HgDiffGenerator.stopProcess"></a>

eric ide

mercurial