--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitDescribeDialog</h1>
-
<p>
Module implementing a dialog to show the results of the git describe action.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#GitDescribeDialog">GitDescribeDialog</a></td>
<td>Class implementing a dialog to show the results of the git describe action.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="GitDescribeDialog" ID="GitDescribeDialog"></a>
<h2>GitDescribeDialog</h2>
-
<p>
Class implementing a dialog to show the results of the git describe action.
</p>
+
<h3>Derived from</h3>
QDialog, Ui_GitDescribeDialog
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#GitDescribeDialog.__init__">GitDescribeDialog</a></td>
<td>Constructor</td>
@@ -111,19 +108,20 @@
<td>Public slot to start the tag/branch list command.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="GitDescribeDialog.__init__" ID="GitDescribeDialog.__init__"></a>
<h4>GitDescribeDialog (Constructor)</h4>
<b>GitDescribeDialog</b>(<i>vcs, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>vcs</i> (Git)</dt>
@@ -138,18 +136,18 @@
<a NAME="GitDescribeDialog.__finish" ID="GitDescribeDialog.__finish"></a>
<h4>GitDescribeDialog.__finish</h4>
<b>__finish</b>(<i></i>)
-
<p>
Private slot called when the process finished or the user pressed
the button.
</p>
+
<a NAME="GitDescribeDialog.__procFinished" ID="GitDescribeDialog.__procFinished"></a>
<h4>GitDescribeDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
-
<p>
Private slot connected to the finished signal.
</p>
+
<dl>
<dt><i>exitCode</i> (int)</dt>
@@ -164,7 +162,6 @@
<a NAME="GitDescribeDialog.__readStderr" ID="GitDescribeDialog.__readStderr"></a>
<h4>GitDescribeDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStderr signal.
</p>
@@ -172,10 +169,10 @@
It reads the error output of the process and inserts it into the
error pane.
</p>
+
<a NAME="GitDescribeDialog.__readStdout" ID="GitDescribeDialog.__readStdout"></a>
<h4>GitDescribeDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
-
<p>
Private slot to handle the readyReadStdout signal.
</p>
@@ -183,27 +180,28 @@
It reads the output of the process, formats it and inserts it into
the contents pane.
</p>
+
<a NAME="GitDescribeDialog.__resizeColumns" ID="GitDescribeDialog.__resizeColumns"></a>
<h4>GitDescribeDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
-
<p>
Private method to resize the list columns.
</p>
+
<a NAME="GitDescribeDialog.__resort" ID="GitDescribeDialog.__resort"></a>
<h4>GitDescribeDialog.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the tree.
</p>
+
<a NAME="GitDescribeDialog.closeEvent" ID="GitDescribeDialog.closeEvent"></a>
<h4>GitDescribeDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
-
<p>
Protected slot implementing a close event handler.
</p>
+
<dl>
<dt><i>e</i> (QCloseEvent)</dt>
@@ -214,10 +212,10 @@
<a NAME="GitDescribeDialog.keyPressEvent" ID="GitDescribeDialog.keyPressEvent"></a>
<h4>GitDescribeDialog.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)
-
<p>
Protected slot to handle a key press event.
</p>
+
<dl>
<dt><i>evt</i> (QKeyEvent)</dt>
@@ -228,10 +226,10 @@
<a NAME="GitDescribeDialog.on_buttonBox_clicked" ID="GitDescribeDialog.on_buttonBox_clicked"></a>
<h4>GitDescribeDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
-
<p>
Private slot called by a button of the button box clicked.
</p>
+
<dl>
<dt><i>button</i> (QAbstractButton)</dt>
@@ -242,17 +240,17 @@
<a NAME="GitDescribeDialog.on_input_returnPressed" ID="GitDescribeDialog.on_input_returnPressed"></a>
<h4>GitDescribeDialog.on_input_returnPressed</h4>
<b>on_input_returnPressed</b>(<i></i>)
-
<p>
Private slot to handle the press of the return key in the input field.
</p>
+
<a NAME="GitDescribeDialog.on_passwordCheckBox_toggled" ID="GitDescribeDialog.on_passwordCheckBox_toggled"></a>
<h4>GitDescribeDialog.on_passwordCheckBox_toggled</h4>
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
-
<p>
Private slot to handle the password checkbox toggled.
</p>
+
<dl>
<dt><i>isOn</i> (bool)</dt>
@@ -263,17 +261,17 @@
<a NAME="GitDescribeDialog.on_sendButton_clicked" ID="GitDescribeDialog.on_sendButton_clicked"></a>
<h4>GitDescribeDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)
-
<p>
Private slot to send the input to the git process.
</p>
+
<a NAME="GitDescribeDialog.start" ID="GitDescribeDialog.start"></a>
<h4>GitDescribeDialog.start</h4>
<b>start</b>(<i>path, commits</i>)
-
<p>
Public slot to start the tag/branch list command.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -287,4 +285,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
