Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Cooperation.CooperationClient.html	Tue Dec 19 11:04:03 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Cooperation.CooperationClient.html	Tue Dec 19 19:57:08 2023 +0100
@@ -202,9 +202,9 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
 </dl>
 <a NAME="CooperationClient.__connectionError" ID="CooperationClient.__connectionError"></a>
@@ -234,9 +234,9 @@
 </p>
 <dl>
 
-<dt><i>msg</i></dt>
+<dt><i>msg</i> (str)</dt>
 <dd>
-error message (string)
+error message
 </dd>
 </dl>
 <a NAME="CooperationClient.__disconnected" ID="CooperationClient.__disconnected"></a>
@@ -262,16 +262,21 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name in the format of self.nickName() (string)
+nick name in the format of self.nickName()
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of references to the connection objects (list of
-            Connection)
+list of references to the connection objects
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of Connection
 </dd>
 </dl>
 <a NAME="CooperationClient.__getParticipants" ID="CooperationClient.__getParticipants"></a>
@@ -298,9 +303,9 @@
 </p>
 <dl>
 
-<dt><i>connection</i></dt>
+<dt><i>connection</i> (Connection)</dt>
 <dd>
-reference to the new connection (Connection)
+reference to the new connection
 </dd>
 </dl>
 <a NAME="CooperationClient.__processParticipants" ID="CooperationClient.__processParticipants"></a>
@@ -312,10 +317,9 @@
 </p>
 <dl>
 
-<dt><i>participants</i></dt>
+<dt><i>participants</i> (list of str)</dt>
 <dd>
-list of participants (list of strings of
-            "host:port")
+list of participants (list of "host:port" strings)
 </dd>
 </dl>
 <a NAME="CooperationClient.__readyForUse" ID="CooperationClient.__readyForUse"></a>
@@ -341,9 +345,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name in the format of self.nickName() (string)
+nick name in the format of self.nickName()
 </dd>
 </dl>
 <a NAME="CooperationClient.banUser" ID="CooperationClient.banUser"></a>
@@ -355,9 +359,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name in the format of self.nickName() (string)
+nick name in the format of self.nickName()
 </dd>
 </dl>
 <a NAME="CooperationClient.chatWidget" ID="CooperationClient.chatWidget"></a>
@@ -370,7 +374,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the chat widget (ChatWidget)
+reference to the chat widget
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+ChatWidget
 </dd>
 </dl>
 <a NAME="CooperationClient.close" ID="CooperationClient.close"></a>
@@ -389,13 +399,13 @@
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-host to connect to (string)
+host to connect to
 </dd>
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-port to connect to (integer)
+port to connect to
 </dd>
 </dl>
 <a NAME="CooperationClient.disconnectConnections" ID="CooperationClient.disconnectConnections"></a>
@@ -417,7 +427,12 @@
 <dt>Return:</dt>
 <dd>
 human readable error message about the last server error
-            (string)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="CooperationClient.hasConnection" ID="CooperationClient.hasConnection"></a>
@@ -429,19 +444,25 @@
 </p>
 <dl>
 
-<dt><i>senderIp</i></dt>
+<dt><i>senderIp</i> (QHostAddress)</dt>
 <dd>
-address of the sender (QHostAddress)
+address of the sender
 </dd>
-<dt><i>senderPort</i></dt>
+<dt><i>senderPort</i> (int)</dt>
 <dd>
-port of the sender (integer)
+port of the sender
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an existing connection (boolean)
+flag indicating an existing connection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="CooperationClient.hasConnections" ID="CooperationClient.hasConnections"></a>
@@ -454,7 +475,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the presence of connections (boolean)
+flag indicating the presence of connections
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="CooperationClient.isListening" ID="CooperationClient.isListening"></a>
@@ -467,7 +494,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the listening state (boolean)
+flag indicating the listening state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="CooperationClient.kickUser" ID="CooperationClient.kickUser"></a>
@@ -479,9 +512,9 @@
 </p>
 <dl>
 
-<dt><i>nick</i></dt>
+<dt><i>nick</i> (str)</dt>
 <dd>
-nick name in the format of self.nickName() (string)
+nick name in the format of self.nickName()
 </dd>
 </dl>
 <a NAME="CooperationClient.nickName" ID="CooperationClient.nickName"></a>
@@ -494,7 +527,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-nick name (string)
+nick name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="CooperationClient.removeConnection" ID="CooperationClient.removeConnection"></a>
@@ -506,10 +545,9 @@
 </p>
 <dl>
 
-<dt><i>connection</i></dt>
+<dt><i>connection</i> (Connection)</dt>
 <dd>
 reference to the connection to be removed
-            (Connection)
 </dd>
 </dl>
 <a NAME="CooperationClient.sendEditorCommand" ID="CooperationClient.sendEditorCommand"></a>
@@ -521,18 +559,18 @@
 </p>
 <dl>
 
-<dt><i>projectHash</i></dt>
+<dt><i>projectHash</i> (str)</dt>
 <dd>
-hash of the project (string)
+hash of the project
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 project relative universal file name of
-            the sending editor (string)
+            the sending editor
 </dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-editor command to be sent (string)
+editor command to be sent
 </dd>
 </dl>
 <a NAME="CooperationClient.sendMessage" ID="CooperationClient.sendMessage"></a>
@@ -544,9 +582,9 @@
 </p>
 <dl>
 
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
 <dd>
-message to be sent (string)
+message to be sent
 </dd>
 </dl>
 <a NAME="CooperationClient.startListening" ID="CooperationClient.startListening"></a>
@@ -558,16 +596,22 @@
 </p>
 <dl>
 
-<dt><i>port</i></dt>
+<dt><i>port</i> (int)</dt>
 <dd>
-port to listen on (integer)
+port to listen on
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple giving a flag indicating success (boolean) and
-            the port the server listens on
+tuple giving a flag indicating success and the port the
+            server listens on
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, int)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>