Skip to content

Commit 53906dc

Browse files
committed
[WASimClient_CLI] Adjust some comments and clarify the non-zero requirement for Client ID.
1 parent 9475a5c commit 53906dc

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

src/WASimClient_CLI/WASimClient_CLI.h

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -82,24 +82,27 @@ namespace WASimCommander::CLI::Client
8282
event ResponseDelegate ^ OnResponseReceived DELEGATE_DECL(ResponseDelegate);
8383
#undef DELEGATE_DECL
8484

85-
/// <summary> Construct a new client with the given ID. The ID should be unique among any other possible clients. </summary>
85+
/// <summary> Construct a new client with the given ID. The ID must be unique among any other possible clients and cannot be zero. </summary>
8686
/// See \refwcc{WASimClient::WASimClient()} for more details.
8787
explicit WASimClient(UInt32 clientId);
8888
/// <summary> Construct a new client with the given ID and with initial settings read from the file specified in `configFile` (.ini format, see default file for example). </summary>
89-
/// The client ID should be unique among any other possible clients. See \refwcc{WASimClient::WASimClient()} for more details.
89+
/// The client ID must be unique among any other possible clients and cannot be zero. See \refwcc{WASimClient::WASimClient()} for more details.
9090
explicit WASimClient(UInt32 clientId, String ^configFile);
91-
/// This class implements a Disposable type object and should be disposed-of appropriately.
92-
/// Any open network connections are automatically closed upon destruction, though it is better to close them yourself before deleting the client
91+
/// <summary> This class implements a Disposable type object and should be disposed-of appropriately.
92+
/// Any open network connections are automatically closed upon destruction, though it is better to close them yourself before deleting the client. </summary>
9393
~WASimClient();
9494
!WASimClient(); ///< \private
9595

9696
// Status -----------------------------------
9797

9898
ClientStatus status() { return (ClientStatus)m_client->status(); }
99-
99+
/// <summary> Returns true if connected to the Simulator (SimConnect). </summary>
100100
bool isInitialized() { return m_client->isInitialized(); }
101+
/// <summary> Returns true if connected to WASimModule server. </summary>
101102
bool isConnected() { return m_client->isConnected(); }
103+
/// <summary> Returns version number of the WASimClient. </summary>
102104
uint32_t clientVersion() { return m_client->clientVersion(); }
105+
/// <summary> Returns version number of the WASimModule server, if known. The version is populated after a successful Ping command or server connection. </summary>
103106
uint32_t serverVersion() { return m_client->serverVersion(); }
104107

105108
// Network actions -----------------------------------

0 commit comments

Comments
 (0)