Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.UI.CompareDialog.html	Thu Dec 21 15:46:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.UI.CompareDialog.html	Thu Dec 21 19:50:01 2023 +0100
@@ -148,7 +148,7 @@
 </p>
 <dl>
 
-<dt><i>files</i> (list of two tuples of (str, str))</dt>
+<dt><i>files</i> (list of tuples of (str, str))</dt>
 <dd>
 list of files to compare and their label
 </dd>
@@ -166,25 +166,25 @@
 </p>
 <dl>
 
-<dt><i>pane</i></dt>
+<dt><i>pane</i> (QTextedit)</dt>
 <dd>
-text edit widget to append text to (QTextedit)
+text edit widget to append text to
 </dd>
-<dt><i>linenumber</i></dt>
+<dt><i>linenumber</i> (str)</dt>
 <dd>
-number of line to insert (string)
+number of line to insert
 </dd>
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-text to insert (string)
+text to insert
 </dd>
-<dt><i>charFormat</i></dt>
+<dt><i>charFormat</i> (QTextCharFormat)</dt>
 <dd>
-text format to be used (QTextCharFormat)
+text format to be used
 </dd>
-<dt><i>interLine</i></dt>
+<dt><i>interLine</i> (bool)</dt>
 <dd>
-flag indicating interline changes (boolean)
+flag indicating interline changes
 </dd>
 </dl>
 <a NAME="CompareDialog.__compare" ID="CompareDialog.__compare"></a>
@@ -196,13 +196,13 @@
 </p>
 <dl>
 
-<dt><i>lines1</i></dt>
+<dt><i>lines1</i> (list of str)</dt>
 <dd>
-text to compare against (list of strings)
+text to compare against
 </dd>
-<dt><i>lines2</i></dt>
+<dt><i>lines2</i> (list of str)</dt>
 <dd>
-text to compare (list of strings)
+text to compare
 </dd>
 </dl>
 <a NAME="CompareDialog.__fileChanged" ID="CompareDialog.__fileChanged"></a>
@@ -236,9 +236,9 @@
 </p>
 <dl>
 
-<dt><i>value</i></dt>
+<dt><i>value</i> (int)</dt>
 <dd>
-scrollbar position (integer)
+scrollbar position
 </dd>
 </dl>
 <a NAME="CompareDialog.compare" ID="CompareDialog.compare"></a>
@@ -250,21 +250,21 @@
 </p>
 <dl>
 
-<dt><i>lines1</i></dt>
+<dt><i>lines1</i> (str or list of str)</dt>
 <dd>
-text to compare against (string or list of strings)
+text to compare against
 </dd>
-<dt><i>lines2</i></dt>
+<dt><i>lines2</i> (str or list of str))</dt>
 <dd>
-text to compare (string or list of strings)
+text to compare
 </dd>
-<dt><i>name1</i></dt>
+<dt><i>name1</i> (str)</dt>
 <dd>
-name to be shown for the first text (string)
+name to be shown for the first text
 </dd>
-<dt><i>name2</i></dt>
+<dt><i>name2</i> (str)</dt>
 <dd>
-name to be shown for the second text (string)
+name to be shown for the second text
 </dd>
 </dl>
 <a NAME="CompareDialog.on_buttonBox_clicked" ID="CompareDialog.on_buttonBox_clicked"></a>
@@ -276,9 +276,9 @@
 </p>
 <dl>
 
-<dt><i>button</i></dt>
+<dt><i>button</i> (QAbstractButton)</dt>
 <dd>
-button that was clicked (QAbstractButton)
+button that was clicked
 </dd>
 </dl>
 <a NAME="CompareDialog.on_diffButton_clicked" ID="CompareDialog.on_diffButton_clicked"></a>
@@ -318,9 +318,9 @@
 </p>
 <dl>
 
-<dt><i>sync</i></dt>
+<dt><i>sync</i> (bool)</dt>
 <dd>
-flag indicating synchronisation status (boolean)
+flag indicating synchronisation status
 </dd>
 </dl>
 <a NAME="CompareDialog.on_upButton_clicked" ID="CompareDialog.on_upButton_clicked"></a>
@@ -339,9 +339,9 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of a file to use as the first file (string)
+name of a file to use as the first file
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -393,14 +393,13 @@
 </p>
 <dl>
 
-<dt><i>files</i></dt>
+<dt><i>files</i> (list of [(str, str), (str, str)])</dt>
 <dd>
 list of files to compare and their label
-            (list of two tuples of two strings)
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="CompareWindow.eventFilter" ID="CompareWindow.eventFilter"></a>
@@ -412,19 +411,25 @@
 </p>
 <dl>
 
-<dt><i>obj</i></dt>
+<dt><i>obj</i> (QObject)</dt>
 <dd>
-reference to the object the event is meant for (QObject)
+reference to the object the event is meant for
 </dd>
-<dt><i>event</i></dt>
+<dt><i>event</i> (QEvent)</dt>
 <dd>
-reference to the event object (QEvent)
+reference to the event object
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating, whether the event was handled (boolean)
+flag indicating, whether the event was handled
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -439,15 +444,21 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-line to work on (string)
+line to work on
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-line without diff markers (string)
+line without diff markers
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -463,17 +474,17 @@
 </p>
 <dl>
 
-<dt><i>a</i></dt>
+<dt><i>a</i> (list of str)</dt>
 <dd>
-first sequence of lines (list of strings)
+first sequence of lines
 </dd>
-<dt><i>b</i></dt>
+<dt><i>b</i> (list of str)</dt>
 <dd>
-second sequence of lines (list of strings)
+second sequence of lines
 </dd>
-<dt><i>linenumberwidth</i></dt>
+<dt><i>linenumberwidth</i> (int)</dt>
 <dd>
-width (in characters) of the linenumbers (integer)
+width (in characters) of the linenumbers
 </dd>
 </dl>
 <dl>