--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgClient.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgClient.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,54 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgClient</h1>
-
<p>
Module implementing an interface to the Mercurial command server.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#HgClient">HgClient</a></td>
<td>Class implementing the Mercurial command server interface.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="HgClient" ID="HgClient"></a>
<h2>HgClient</h2>
-
<p>
Class implementing the Mercurial command server interface.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>Channels</td></tr>
+<tr><td>InputFormat</td></tr>
+<tr><td>OutputFormat</td></tr>
+<tr><td>OutputFormatSize</td></tr>
+<tr><td>ReturnFormat</td></tr>
+</table>
-<table>
-<tr><td>Channels</td></tr><tr><td>InputFormat</td></tr><tr><td>OutputFormat</td></tr><tr><td>OutputFormatSize</td></tr><tr><td>ReturnFormat</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#HgClient.__init__">HgClient</a></td>
<td>Constructor</td>
@@ -123,19 +124,20 @@
<td>Public method to check, if the last command was canceled.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="HgClient.__init__" ID="HgClient.__init__"></a>
<h4>HgClient (Constructor)</h4>
<b>HgClient</b>(<i>repoPath, encoding, vcs, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>repoPath</i> (str)</dt>
@@ -158,10 +160,10 @@
<a NAME="HgClient.__prompt" ID="HgClient.__prompt"></a>
<h4>HgClient.__prompt</h4>
<b>__prompt</b>(<i>size, message</i>)
-
<p>
Private method to prompt the user for some input.
</p>
+
<dl>
<dt><i>size</i> (int)</dt>
@@ -189,10 +191,10 @@
<a NAME="HgClient.__readChannel" ID="HgClient.__readChannel"></a>
<h4>HgClient.__readChannel</h4>
<b>__readChannel</b>(<i></i>)
-
<p>
Private method to read data from the command server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -208,10 +210,10 @@
<a NAME="HgClient.__readHello" ID="HgClient.__readHello"></a>
<h4>HgClient.__readHello</h4>
<b>__readHello</b>(<i></i>)
-
<p>
Private method to read the hello message sent by the command server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -228,10 +230,10 @@
<a NAME="HgClient.__runcommand" ID="HgClient.__runcommand"></a>
<h4>HgClient.__runcommand</h4>
<b>__runcommand</b>(<i>args, inputChannels, outputChannels</i>)
-
<p>
Private method to run a command in the server (low level).
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -275,10 +277,10 @@
<a NAME="HgClient.__serverFinished" ID="HgClient.__serverFinished"></a>
<h4>HgClient.__serverFinished</h4>
<b>__serverFinished</b>(<i>exitCode, exitStatus</i>)
-
<p>
Private slot connected to the finished signal.
</p>
+
<dl>
<dt><i>exitCode</i> (int)</dt>
@@ -293,10 +295,10 @@
<a NAME="HgClient.__writeDataBlock" ID="HgClient.__writeDataBlock"></a>
<h4>HgClient.__writeDataBlock</h4>
<b>__writeDataBlock</b>(<i>data</i>)
-
<p>
Private slot to write some data to the command server.
</p>
+
<dl>
<dt><i>data</i> (str)</dt>
@@ -307,10 +309,10 @@
<a NAME="HgClient.cancel" ID="HgClient.cancel"></a>
<h4>HgClient.cancel</h4>
<b>cancel</b>(<i></i>)
-
<p>
Public method to cancel the running command.
</p>
+
<a NAME="HgClient.func" ID="HgClient.func"></a>
<h4>HgClient.func</h4>
<b>func</b>(<i></i>)
@@ -318,10 +320,10 @@
<a NAME="HgClient.getRepository" ID="HgClient.getRepository"></a>
<h4>HgClient.getRepository</h4>
<b>getRepository</b>(<i></i>)
-
<p>
Public method to get the repository path this client is serving.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -337,10 +339,10 @@
<a NAME="HgClient.isExecuting" ID="HgClient.isExecuting"></a>
<h4>HgClient.isExecuting</h4>
<b>isExecuting</b>(<i></i>)
-
<p>
Public method to check, if the server is executing a command.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -360,10 +362,10 @@
<a NAME="HgClient.restartServer" ID="HgClient.restartServer"></a>
<h4>HgClient.restartServer</h4>
<b>restartServer</b>(<i></i>)
-
<p>
Public method to restart the command server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -380,10 +382,10 @@
<a NAME="HgClient.runcommand" ID="HgClient.runcommand"></a>
<h4>HgClient.runcommand</h4>
<b>runcommand</b>(<i>args, prompt=None, inputData=None, output=None, error=None</i>)
-
<p>
Public method to execute a command via the command server.
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -432,10 +434,10 @@
<a NAME="HgClient.startServer" ID="HgClient.startServer"></a>
<h4>HgClient.startServer</h4>
<b>startServer</b>(<i></i>)
-
<p>
Public method to start the command server.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -452,17 +454,17 @@
<a NAME="HgClient.stopServer" ID="HgClient.stopServer"></a>
<h4>HgClient.stopServer</h4>
<b>stopServer</b>(<i></i>)
-
<p>
Public method to stop the command server.
</p>
+
<a NAME="HgClient.wasCanceled" ID="HgClient.wasCanceled"></a>
<h4>HgClient.wasCanceled</h4>
<b>wasCanceled</b>(<i></i>)
-
<p>
Public method to check, if the last command was canceled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -477,4 +479,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
