diff -r e28b89693f37 -r 299802979277 src/eric7/Documentation/Source/eric7.Cooperation.Connection.html --- a/src/eric7/Documentation/Source/eric7.Cooperation.Connection.html Tue Dec 19 11:04:03 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Cooperation.Connection.html Tue Dec 19 19:57:08 2023 +0100 @@ -179,9 +179,9 @@ </p> <dl> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QObject)</dt> <dd> -referenec to the parent object (QObject) +referenec to the parent object </dd> </dl> <a NAME="Connection.__dataLengthForCurrentDataType" ID="Connection.__dataLengthForCurrentDataType"></a> @@ -194,7 +194,13 @@ <dl> <dt>Return:</dt> <dd> -data length (integer) +data length +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Connection.__disconnected" ID="Connection.__disconnected"></a> @@ -214,7 +220,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating availability of enough data (boolean) +flag indicating availability of enough data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Connection.__processData" ID="Connection.__processData"></a> @@ -240,15 +252,21 @@ </p> <dl> -<dt><i>maxSize</i></dt> +<dt><i>maxSize</i> (int)</dt> <dd> -maximum size of data to read (integer) +maximum size of data to read </dd> </dl> <dl> <dt>Return:</dt> <dd> -size of data read (integer) +size of data read +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Connection.__readProtocolHeader" ID="Connection.__readProtocolHeader"></a> @@ -261,7 +279,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a successful read (boolean) +flag indicating a successful read +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Connection.__sendGreetingMessage" ID="Connection.__sendGreetingMessage"></a> @@ -288,7 +312,13 @@ <dl> <dt>Return:</dt> <dd> -connection name (string) +connection name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="Connection.sendEditorCommand" ID="Connection.sendEditorCommand"></a> @@ -300,18 +330,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="Connection.sendGetParticipants" ID="Connection.sendGetParticipants"></a> @@ -330,15 +360,21 @@ </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> <dl> <dt>Return:</dt> <dd> -flag indicating a successful send (boolean) +flag indicating a successful send +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="Connection.sendParticipants" ID="Connection.sendParticipants"></a> @@ -350,10 +386,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="Connection.serverPort" ID="Connection.serverPort"></a> @@ -366,7 +401,13 @@ <dl> <dt>Return:</dt> <dd> -server port (integer) +server port +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="Connection.setClient" ID="Connection.setClient"></a> @@ -378,9 +419,9 @@ </p> <dl> -<dt><i>client</i></dt> +<dt><i>client</i> (CooperationClient)</dt> <dd> -reference to the cooperation client (CooperationClient) +reference to the cooperation client </dd> </dl> <a NAME="Connection.setGreetingMessage" ID="Connection.setGreetingMessage"></a> @@ -392,13 +433,13 @@ </p> <dl> -<dt><i>message</i></dt> +<dt><i>message</i> (str)</dt> <dd> -greeting message (string) +greeting message </dd> -<dt><i>serverPort</i></dt> +<dt><i>serverPort</i> (int)</dt> <dd> -port number to include in the message (integer) +port number to include in the message </dd> </dl> <a NAME="Connection.timerEvent" ID="Connection.timerEvent"></a> @@ -410,9 +451,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QTimerEvent)</dt> <dd> -reference to the timer event (QTimerEvent) +reference to the timer event </dd> </dl> <div align="right"><a href="#top">Up</a></div>