Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffGenerator.html	Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDiffGenerator.html	Sat Dec 23 15:40:23 2023 +0100
@@ -115,13 +115,13 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Git)</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="GitDiffGenerator.__procFinished" ID="GitDiffGenerator.__procFinished"></a>
@@ -133,13 +133,13 @@
 </p>
 <dl>
 
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
+exit code of the process
 </dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl>
 <a NAME="GitDiffGenerator.__processFileLine" ID="GitDiffGenerator.__processFileLine"></a>
@@ -151,14 +151,14 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-line to be processed (string)
+line to be processed
 </dd>
-<dt><i>isTopDiff</i></dt>
+<dt><i>isTopDiff</i> (bool)</dt>
 <dd>
 flag indicating to show the output in the top
-            output widget (boolean)
+            output widget
 </dd>
 </dl>
 <a NAME="GitDiffGenerator.__processLine" ID="GitDiffGenerator.__processLine"></a>
@@ -170,14 +170,14 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-output line to process (string)
+output line to process
 </dd>
-<dt><i>isTopDiff</i></dt>
+<dt><i>isTopDiff</i> (bool)</dt>
 <dd>
 flag indicating to show the output in the top
-            output widget (boolean)
+            output widget
 </dd>
 </dl>
 <a NAME="GitDiffGenerator.__readStderr" ID="GitDiffGenerator.__readStderr"></a>
@@ -232,6 +232,12 @@
             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 str, list of (str, int))
+</dd>
+</dl>
 <a NAME="GitDiffGenerator.start" ID="GitDiffGenerator.start"></a>
 <h4>GitDiffGenerator.start</h4>
 <b>start</b>(<i>fn, versions=None, diffMode="work2repo", stashName=""</i>)
@@ -241,16 +247,15 @@
 </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>diffMode</i></dt>
+<dt><i>diffMode</i> (str)</dt>
 <dd>
 indication for the type of diff to be performed (
             'work2repo' compares the working tree with the HEAD commit,
@@ -260,15 +265,21 @@
                 and the staging area with the HEAD commit,
             'stash' shows the diff for a stash)
 </dd>
-<dt><i>stashName</i></dt>
+<dt><i>stashName</i> (str)</dt>
 <dd>
-name of the stash to show a diff for (string)
+name of the stash to show a diff for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the start status (boolean)
+flag indicating the start status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <dl>