Documentation for module: Network

Former-commit-id: cb5674c011d3d6895848cab77bb2e4a05e5d9b7b

include/Nazara/Network/TcpClient.inl

@@ -7,6 +7,10 @@
 
 namespace Nz
 {
+	/*!
+	* \brief Constructs a TcpClient object by default
+	*/
+
 	inline TcpClient::TcpClient() :
 	AbstractSocket(SocketType_TCP),
 	Stream(StreamOption_Sequential),
@@ -17,31 +21,62 @@ namespace Nz
 	{
 	}
 
+	/*!
+	* \brief Disconnects the connection
+	*
+	* \see Close
+	*/
+
 	inline void TcpClient::Disconnect()
 	{
 		Close();
 	}
 
+	/*!
+	* \brief Gets the interval between two keep alive pings
+	* \return Interval in milliseconds between two pings
+	*/
+
 	inline UInt64 TcpClient::GetKeepAliveInterval() const
 	{
 		return m_keepAliveInterval;
 	}
 
+	/*!
+	* \brief Gets the time before expiration of connection
+	* \return Time in milliseconds before expiration
+	*/
+
 	inline UInt64 TcpClient::GetKeepAliveTime() const
 	{
 		return m_keepAliveTime;
 	}
 
+	/*!
+	* \brief Gets the remote address
+	* \return Address of peer
+	*/
+
 	inline IpAddress TcpClient::GetRemoteAddress() const
 	{
 		return m_peerAddress;
 	}
 
+	/*!
+	* \brief Checks whether low delay is enabled
+	* \return true If it is the case
+	*/
+
 	inline bool TcpClient::IsLowDelayEnabled() const
 	{
 		return m_isLowDelayEnabled;
 	}
 
+	/*!
+	* \brief Checks whether the keep alive flag is enabled
+	* \return true If it is the case
+	*/
+
 	inline bool TcpClient::IsKeepAliveEnabled() const
 	{
 		return m_isKeepAliveEnabled;