diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html Sat Dec 23 15:40:23 2023 +0100
@@ -398,13 +398,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="GitLogBrowserDialog.__actionMode" ID="GitLogBrowserDialog.__actionMode"></a>
@@ -417,7 +417,13 @@
<dl>
<dt>Return:</dt>
<dd>
-selected action mode (string, one of filter or find)
+selected action mode (one of 'filter' or 'find')
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__addFinishCallback" ID="GitLogBrowserDialog.__addFinishCallback"></a>
@@ -498,13 +504,13 @@
</p>
<dl>
-<dt><i>backwards</i></dt>
+<dt><i>backwards</i> (bool)</dt>
<dd>
-flag indicating to search backwards (boolean)
+flag indicating to search backwards
</dd>
-<dt><i>interactive</i></dt>
+<dt><i>interactive</i> (bool)</dt>
<dd>
-flag indicating an interactive search (boolean)
+flag indicating an interactive search
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__finish" ID="GitLogBrowserDialog.__finish"></a>
@@ -565,13 +571,13 @@
</p>
<dl>
-<dt><i>commitId</i></dt>
+<dt><i>commitId</i> (str)</dt>
<dd>
-commit id to calculate edge info for (string)
+commit id to calculate edge info for
</dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of str)</dt>
<dd>
-list of parent commits (list of strings)
+list of parent commits
</dd>
</dl>
<dl>
@@ -580,7 +586,12 @@
tuple containing the column and color index for
the given node and a list of tuples indicating the edges
between the given node and its parents
- (integer, integer, [(integer, integer, integer), ...])
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, int, [(int, int, int), ...])
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__generateFileItem" ID="GitLogBrowserDialog.__generateFileItem"></a>
@@ -592,32 +603,38 @@
</p>
<dl>
-<dt><i>action</i></dt>
+<dt><i>action</i> (str)</dt>
<dd>
indicator for the change action ("A", "C", "D", "M",
"R", "T", "U", "X")
</dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-path of the file in the repository (string)
+path of the file in the repository
</dd>
-<dt><i>copyfrom</i></dt>
+<dt><i>copyfrom</i> (str)</dt>
<dd>
-path the file was copied from (string)
+path the file was copied from
</dd>
-<dt><i>additions</i></dt>
+<dt><i>additions</i> (int)</dt>
<dd>
-number of added lines (int)
+number of added lines
</dd>
-<dt><i>deletions</i></dt>
+<dt><i>deletions</i> (int)</dt>
<dd>
-number of deleted lines (int)
+number of deleted lines
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the generated item (QTreeWidgetItem)
+reference to the generated item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__generateIcon" ID="GitLogBrowserDialog.__generateIcon"></a>
@@ -630,34 +647,38 @@
</p>
<dl>
-<dt><i>column</i></dt>
+<dt><i>column</i> (int)</dt>
<dd>
-column index of the revision (integer)
+column index of the revision
</dd>
-<dt><i>bottomedges</i></dt>
+<dt><i>bottomedges</i> (list of [(int, int, int)])</dt>
<dd>
list of edges for the bottom of the node
- (list of tuples of three integers)
</dd>
-<dt><i>topedges</i></dt>
+<dt><i>topedges</i> (list of [(int, int, int)])</dt>
<dd>
list of edges for the top of the node
- (list of tuples of three integers)
</dd>
-<dt><i>dotColor</i></dt>
+<dt><i>dotColor</i> (QColor)</dt>
<dd>
-color to be used for the dot (QColor)
+color to be used for the dot
</dd>
-<dt><i>currentCommit</i></dt>
+<dt><i>currentCommit</i> (bool)</dt>
<dd>
flag indicating to draw the icon for the
- current commit (boolean)
+ current commit
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-icon for the node (QIcon)
+icon for the node
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QIcon
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__generateLogItem" ID="GitLogBrowserDialog.__generateLogItem"></a>
@@ -669,64 +690,70 @@
</p>
<dl>
-<dt><i>author</i></dt>
+<dt><i>author</i> (str)</dt>
<dd>
-author info (string)
+author info
</dd>
-<dt><i>date</i></dt>
+<dt><i>date</i> (str)</dt>
<dd>
-date info (string)
+date info
</dd>
-<dt><i>committer</i></dt>
+<dt><i>committer</i> (str)</dt>
<dd>
-committer info (string)
+committer info
</dd>
-<dt><i>commitDate</i></dt>
+<dt><i>commitDate</i> (str)</dt>
<dd>
-commit date info (string)
+commit date info
</dd>
-<dt><i>subject</i></dt>
+<dt><i>subject</i> (str)</dt>
<dd>
-subject of the log entry (string)
+subject of the log entry
</dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (list of str)</dt>
<dd>
-text of the log message (list of strings)
+text of the log message
</dd>
-<dt><i>commitId</i></dt>
+<dt><i>commitId</i> (str)</dt>
<dd>
-commit id info (string)
+commit id info
</dd>
-<dt><i>fullCommitId</i></dt>
+<dt><i>fullCommitId</i> (str)</dt>
<dd>
-unabbreviated commit id info (string)
+unabbreviated commit id info
</dd>
-<dt><i>changedPaths</i></dt>
+<dt><i>changedPaths</i> (list of dict)</dt>
<dd>
list of dictionary objects containing
info about the changed files/directories
</dd>
-<dt><i>parents</i></dt>
+<dt><i>parents</i> (list of int)</dt>
<dd>
-list of parent revisions (list of integers)
+list of parent revisions
</dd>
-<dt><i>refnames</i></dt>
+<dt><i>refnames</i> (str)</dt>
<dd>
-tags and branches of the commit (string)
+tags and branches of the commit
</dd>
-<dt><i>authorMail</i></dt>
+<dt><i>authorMail</i> (str)</dt>
<dd>
-author's email address (string)
+author's email address
</dd>
-<dt><i>committerMail</i></dt>
+<dt><i>committerMail</i> (str)</dt>
<dd>
-committer's email address (string)
+committer's email address
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the generated item (QTreeWidgetItem)
+reference to the generated item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__generatorFinished" ID="GitLogBrowserDialog.__generatorFinished"></a>
@@ -798,15 +825,21 @@
</p>
<dl>
-<dt><i>tag</i></dt>
+<dt><i>tag</i> (str)</dt>
<dd>
-tag name (string)
+tag name
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-commit id shortened to 10 characters (string)
+commit id shortened to 10 characters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__getLogEntries" ID="GitLogBrowserDialog.__getLogEntries"></a>
@@ -818,13 +851,13 @@
</p>
<dl>
-<dt><i>skip</i></dt>
+<dt><i>skip</i> (int)</dt>
<dd>
-number of log entries to skip (integer)
+number of log entries to skip
</dd>
-<dt><i>noEntries</i></dt>
+<dt><i>noEntries</i> (int)</dt>
<dd>
-number of entries to get (0 = default) (int)
+number of entries to get (0 = default)
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__getTagsForCommit" ID="GitLogBrowserDialog.__getTagsForCommit"></a>
@@ -891,7 +924,7 @@
</p>
<dl>
-<dt><i>fileSeparators</i></dt>
+<dt><i>fileSeparators</i> (list of str)</dt>
<dd>
list of file separator entries to be merged
</dd>
@@ -902,6 +935,12 @@
merged list of file separator entries
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
<a NAME="GitLogBrowserDialog.__prepareFieldSearch" ID="GitLogBrowserDialog.__prepareFieldSearch"></a>
<h4>GitLogBrowserDialog.__prepareFieldSearch</h4>
<b>__prepareFieldSearch</b>(<i></i>)
@@ -913,7 +952,13 @@
<dt>Return:</dt>
<dd>
tuple of field index, search expression and flag indicating
- that the field index is a data role (integer, string, boolean)
+ that the field index is a data role
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (int, str, bool)
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__procFinished" ID="GitLogBrowserDialog.__procFinished"></a>
@@ -925,13 +970,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="GitLogBrowserDialog.__processBuffer" ID="GitLogBrowserDialog.__processBuffer"></a>
@@ -950,7 +995,7 @@
</p>
<dl>
-<dt><i>logEntry</i></dt>
+<dt><i>logEntry</i> (dict)</dt>
<dd>
dictionary as generated by __processBuffer
</dd>
@@ -1034,9 +1079,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag indicating the selection state (boolean)
+flag indicating the selection state
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__showBranchesColumn" ID="GitLogBrowserDialog.__showBranchesColumn"></a>
@@ -1048,9 +1093,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag indicating the selection state (boolean)
+flag indicating the selection state
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__showCommitIdColumn" ID="GitLogBrowserDialog.__showCommitIdColumn"></a>
@@ -1062,9 +1107,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag indicating the selection state (boolean)
+flag indicating the selection state
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__showCommitterColumns" ID="GitLogBrowserDialog.__showCommitterColumns"></a>
@@ -1076,9 +1121,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag indicating the selection state (boolean)
+flag indicating the selection state
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__showError" ID="GitLogBrowserDialog.__showError"></a>
@@ -1090,9 +1135,9 @@
</p>
<dl>
-<dt><i>out</i></dt>
+<dt><i>out</i> (str)</dt>
<dd>
-error to be shown (string)
+error to be shown
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__showTagsColumn" ID="GitLogBrowserDialog.__showTagsColumn"></a>
@@ -1104,9 +1149,9 @@
</p>
<dl>
-<dt><i>on</i></dt>
+<dt><i>on</i> (bool)</dt>
<dd>
-flag indicating the selection state (boolean)
+flag indicating the selection state
</dd>
</dl>
<a NAME="GitLogBrowserDialog.__switchActTriggered" ID="GitLogBrowserDialog.__switchActTriggered"></a>
@@ -1169,9 +1214,9 @@
</p>
<dl>
-<dt><i>e</i></dt>
+<dt><i>e</i> (QCloseEvent)</dt>
<dd>
-close event (QCloseEvent)
+close event
</dd>
</dl>
<a NAME="GitLogBrowserDialog.col2x" ID="GitLogBrowserDialog.col2x"></a>
@@ -1183,13 +1228,13 @@
</p>
<dl>
-<dt><i>col</i></dt>
+<dt><i>col</i> (int)</dt>
<dd>
-column number (integer)
+column number
</dd>
-<dt><i>radius</i></dt>
+<dt><i>radius</i> (int)</dt>
<dd>
-radius of the indicator circle (integer)
+radius of the indicator circle
</dd>
</dl>
<a NAME="GitLogBrowserDialog.keyPressEvent" ID="GitLogBrowserDialog.keyPressEvent"></a>
@@ -1201,9 +1246,9 @@
</p>
<dl>
-<dt><i>evt</i></dt>
+<dt><i>evt</i> (QKeyEvent)</dt>
<dd>
-the key press event (QKeyEvent)
+the key press event
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_buttonBox_clicked" ID="GitLogBrowserDialog.on_buttonBox_clicked"></a>
@@ -1215,9 +1260,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="GitLogBrowserDialog.on_diffSelectLabel_linkActivated" ID="GitLogBrowserDialog.on_diffSelectLabel_linkActivated"></a>
@@ -1264,13 +1309,13 @@
</p>
<dl>
-<dt><i>current</i></dt>
+<dt><i>current</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the new current item (QTreeWidgetItem)
+reference to the new current item
</dd>
-<dt><i>previous</i></dt>
+<dt><i>previous</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the old current item (QTreeWidgetItem)
+reference to the old current item
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_findNextButton_clicked" ID="GitLogBrowserDialog.on_findNextButton_clicked"></a>
@@ -1296,9 +1341,9 @@
</p>
<dl>
-<dt><i>date</i></dt>
+<dt><i>date</i> (QDate)</dt>
<dd>
-new date (QDate)
+new date
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_input_returnPressed" ID="GitLogBrowserDialog.on_input_returnPressed"></a>
@@ -1317,13 +1362,13 @@
</p>
<dl>
-<dt><i>current</i></dt>
+<dt><i>current</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the new current item (QTreeWidgetItem)
+reference to the new current item
</dd>
-<dt><i>previous</i></dt>
+<dt><i>previous</i> (QTreeWidgetItem)</dt>
<dd>
-reference to the old current item (QTreeWidgetItem)
+reference to the old current item
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_logTree_customContextMenuRequested" ID="GitLogBrowserDialog.on_logTree_customContextMenuRequested"></a>
@@ -1335,9 +1380,9 @@
</p>
<dl>
-<dt><i>pos</i></dt>
+<dt><i>pos</i> (QPoint)</dt>
<dd>
-position of the mouse pointer (QPoint)
+position of the mouse pointer
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_logTree_itemSelectionChanged" ID="GitLogBrowserDialog.on_logTree_itemSelectionChanged"></a>
@@ -1356,9 +1401,9 @@
</p>
<dl>
-<dt><i>index</i></dt>
+<dt><i>index</i> (int)</dt>
<dd>
-index of the selected entry (integer)
+index of the selected entry
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_nextButton_clicked" ID="GitLogBrowserDialog.on_nextButton_clicked"></a>
@@ -1377,9 +1422,9 @@
</p>
<dl>
-<dt><i>isOn</i></dt>
+<dt><i>isOn</i> (bool)</dt>
<dd>
-flag indicating the status of the check box (boolean)
+flag indicating the status of the check box
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_refreshButton_clicked" ID="GitLogBrowserDialog.on_refreshButton_clicked"></a>
@@ -1405,9 +1450,9 @@
</p>
<dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-filter expression (string)
+filter expression
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_saveLabel_linkActivated" ID="GitLogBrowserDialog.on_saveLabel_linkActivated"></a>
@@ -1454,9 +1499,9 @@
</p>
<dl>
-<dt><i>checked</i></dt>
+<dt><i>checked</i> (bool)</dt>
<dd>
-flag indicating the state of the check box (boolean)
+flag indicating the state of the check box
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_toDate_dateChanged" ID="GitLogBrowserDialog.on_toDate_dateChanged"></a>
@@ -1468,9 +1513,9 @@
</p>
<dl>
-<dt><i>date</i></dt>
+<dt><i>date</i> (QDate)</dt>
<dd>
-new date (QDate)
+new date
</dd>
</dl>
<a NAME="GitLogBrowserDialog.on_upButton_clicked" ID="GitLogBrowserDialog.on_upButton_clicked"></a>
@@ -1496,18 +1541,17 @@
</p>
<dl>
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
<dd>
-filename to show the log for (string)
+filename to show the log for
</dd>
-<dt><i>isFile</i></dt>
+<dt><i>isFile</i> (bool)</dt>
<dd>
flag indicating log for a file is to be shown
- (boolean)
</dd>
-<dt><i>noEntries</i></dt>
+<dt><i>noEntries</i> (int)</dt>
<dd>
-number of entries to get (0 = default) (int)
+number of entries to get (0 = default)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
