src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html

branch
eric7
changeset 10423
299802979277
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricGui.EricGenericDiffHighlighter.html	Tue Dec 19 19:57:08 2023 +0100
@@ -106,9 +106,9 @@
 </p>
 <dl>
 
-<dt><i>doc</i></dt>
+<dt><i>doc</i> (QTextDocument)</dt>
 <dd>
-reference to the text document (QTextDocument)
+reference to the text document
 </dd>
 </dl>
 <a NAME="EricGenericDiffHighlighter.__initColours" ID="EricGenericDiffHighlighter.__initColours"></a>
@@ -127,10 +127,10 @@
 </p>
 <dl>
 
-<dt><i>rules</i></dt>
+<dt><i>rules</i> (set of tuple of (str, QTextCharFormat))</dt>
 <dd>
 set of highlighting rules (list of tuples of rule
-            pattern (string) and highlighting format (QTextCharFormat))
+            pattern and highlighting format)
 </dd>
 </dl>
 <a NAME="EricGenericDiffHighlighter.formats" ID="EricGenericDiffHighlighter.formats"></a>
@@ -143,16 +143,22 @@
 </p>
 <dl>
 
-<dt><i>line</i></dt>
+<dt><i>line</i> (str)</dt>
 <dd>
-text line to be highlighted (string)
+text line to be highlighted
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 list of matched highlighting rules (list of tuples of match
-            object and format (QTextCharFormat))
+            object and format)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of tuple of (re.Match, QTextCharFormat)
 </dd>
 </dl>
 <a NAME="EricGenericDiffHighlighter.generateRules" ID="EricGenericDiffHighlighter.generateRules"></a>
@@ -175,9 +181,9 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to be highlighted (string)
+text to be highlighted
 </dd>
 </dl>
 <a NAME="EricGenericDiffHighlighter.makeFormat" ID="EricGenericDiffHighlighter.makeFormat"></a>
@@ -189,23 +195,29 @@
 </p>
 <dl>
 
-<dt><i>fg</i></dt>
+<dt><i>fg</i> (QColor)</dt>
 <dd>
-foreground color (QColor)
+foreground color
 </dd>
-<dt><i>bg</i></dt>
+<dt><i>bg</i> (QColor)</dt>
 <dd>
-background color (QColor)
+background color
 </dd>
-<dt><i>bold</i></dt>
+<dt><i>bold</i> (bool)</dt>
 <dd>
-flag indicating bold text (boolean)
+flag indicating bold text
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-format definiton (QTextCharFormat)
+format definiton
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTextCharFormat
 </dd>
 </dl>
 <a NAME="EricGenericDiffHighlighter.regenerateRules" ID="EricGenericDiffHighlighter.regenerateRules"></a>
@@ -227,15 +239,21 @@
 </p>
 <dl>
 
-<dt><i>pattern</i></dt>
+<dt><i>pattern</i> (str)</dt>
 <dd>
-pattern to be marked (string)
+pattern to be marked
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-marked pattern (string)
+marked pattern
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial