Apply stylistic changes

Co-authored-by: mcfnord <mcfnord@users.noreply.github.com>

Author: ann0see

docs/JSON-RPC.md

@@ -131,13 +131,13 @@ Results:
 
 ### jamulus/pollServerList
 
-Request list of servers in a directory
+Request list of servers in a directory.
 
 Parameters:
 
 | Name | Type | Description |
 | --- | --- | --- |
-| params.directory | string | socket address of directory to query, e.g. anygenre1.jamulus.io:22124. |
+| params.directory | string | Socket address of directory to query. Example: anygenre1.jamulus.io:22124. |
 
 Results:
 
@@ -167,7 +167,7 @@ Results:
 | result.country | string | The musician’s country. |
 | result.city | string | The musician’s city. |
 | result.instrumentId | number | The musician’s instrument ID (see CInstPictures::GetTable). |
-| result.instrument | string | The musician’s instrument. |
+| result.instrument | number | The musician’s instrument. |
 | result.skillLevel | string | Your skill level (beginner, intermediate, expert, or null). |
 
 
@@ -500,7 +500,7 @@ Parameters:
 
 | Name | Type | Description |
 | --- | --- | --- |
-| params.state | number | The recorder state |
+| params.state | number | The recorder state. |
 
 
 ### jamulusclient/serverInfoReceived
@@ -511,9 +511,9 @@ Parameters:
 
 | Name | Type | Description |
 | --- | --- | --- |
-| params.address | string | The server socket address |
-| params.pingtime | number | The round-trip ping time in ms |
-| params.numClients | number | The quantity of clients connected to the server |
+| params.address | string | The server socket address. |
+| params.pingtime | number | The round-trip ping time, in milliseconds. |
+| params.numClients | number | The number of clients connected to the server. |
 
 
 ### jamulusclient/serverListReceived
@@ -525,10 +525,10 @@ Parameters:
 | Name | Type | Description |
 | --- | --- | --- |
 | params.servers | array | The server list. |
-| params.servers[*].address | string | Socket address (ip_address:port) |
-| params.servers[*].name | string | Server name |
+| params.servers[*].address | string | Socket address (ip_address:port). |
+| params.servers[*].name | string | Server name. |
 | params.servers[*].countryId | number | Server country ID (see QLocale::Country). |
-| params.servers[*].country | string | Server country |
-| params.servers[*].city | string | Server city |
+| params.servers[*].country | string | Server country. |
+| params.servers[*].city | string | Server city. |
 
 

src/clientrpc.cpp

@@ -101,11 +101,11 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare
     /// @rpc_notification jamulusclient/serverListReceived
     /// @brief Emitted when the server list is received.
     /// @param {array} params.servers - The server list.
-    /// @param {string} params.servers[*].address - Socket address (ip_address:port)
-    /// @param {string} params.servers[*].name - Server name
+    /// @param {string} params.servers[*].address - Socket address (ip_address:port).
+    /// @param {string} params.servers[*].name - Server name.
     /// @param {number} params.servers[*].countryId - Server country ID (see QLocale::Country).
-    /// @param {string} params.servers[*].country - Server country
-    /// @param {string} params.servers[*].city - Server city
+    /// @param {string} params.servers[*].country - Server country.
+    /// @param {string} params.servers[*].city - Server city.
     connect ( pClient->getConnLessProtocol(),
               &CProtocol::CLServerListReceived,
               [=] ( CHostAddress /* unused */, CVector<CServerInfo> vecServerInfo ) {
@@ -130,9 +130,9 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare
 
     /// @rpc_notification jamulusclient/serverInfoReceived
     /// @brief Emitted when a server info is received.
-    /// @param {string} params.address - The server socket address
-    /// @param {number} params.pingtime - The round-trip ping time in ms
-    /// @param {number} params.numClients - The quantity of clients connected to the server
+    /// @param {string} params.address - The server socket address.
+    /// @param {number} params.pingtime - The round-trip ping time, in milliseconds.
+    /// @param {number} params.numClients - The number of clients connected to the server.
     connect ( pClient, &CClient::CLPingTimeWithNumClientsReceived, [=] ( CHostAddress InetAddr, int iPingTime, int iNumClients ) {
         pRpcServer->BroadcastNotification (
             "jamulusclient/serverInfoReceived",
@@ -145,15 +145,15 @@ CClientRpc::CClientRpc ( CClient* pClient, CRpcServer* pRpcServer, QObject* pare
     connect ( pClient, &CClient::Disconnected, [=]() { pRpcServer->BroadcastNotification ( "jamulusclient/disconnected", QJsonObject{} ); } );
 
     /// @rpc_notification jamulusclient/recorderState
-    /// @brief Emitted when the client is connected to a server who's recorder state changes.
-    /// @param {number} params.state - The recorder state
+    /// @brief Emitted when the client is connected to a server whose recorder state changes.
+    /// @param {number} params.state - The recorder state.
     connect ( pClient, &CClient::RecorderStateReceived, [=] ( const ERecorderState newRecorderState ) {
         pRpcServer->BroadcastNotification ( "jamulusclient/recorderState", QJsonObject{ { "state", newRecorderState } } );
     } );
 
     /// @rpc_method jamulus/pollServerList
-    /// @brief Request list of servers in a directory
-    /// @param {string} params.directory - socket address of directory to query, e.g. anygenre1.jamulus.io:22124.
+    /// @brief Request list of servers in a directory.
+    /// @param {string} params.directory - Socket address of directory to query. Example: anygenre1.jamulus.io:22124.
     /// @result {string} result - "ok" or "error" if bad arguments.
     pRpcServer->HandleMethod ( "jamulusclient/pollServerList", [=] ( const QJsonObject& params, QJsonObject& response ) {
         auto jsonDirectoryIp = params["directory"];