Diff: TCPSocketConnection.h

Revision:

16:2d471deff212

Parent:

14:c159ce890a45

diff -r 41e3af01f58e -r 2d471deff212 TCPSocketConnection.h
--- a/TCPSocketConnection.h	Mon Aug 13 09:38:00 2012 +0000
+++ b/TCPSocketConnection.h	Fri Mar 01 15:30:16 2013 +0000
@@ -45,40 +45,32 @@
     */
     bool is_connected(void);
     
-    /*! \brief Send data to the remote host. Applications are responsible for 
-     *         checking that all data has been sent; if only some of the data was
-     *         transmitted, the application needs to attempt delivery of the
-     *         remaining data.
-     * \param data The buffer to send to the host.
-     * \param length The length of the buffer to send.
-     * \return the number of written bytes on success (>=0) or -1 on failure
+    /** Send data to the remote host.
+    \param data The buffer to send to the host.
+    \param length The length of the buffer to send.
+    \return the number of written bytes on success (>=0) or -1 on failure
      */
     int send(char* data, int length);
     
-    /*! \brief Send all the data to the remote host. This method continues to send
-     *         data until either all data has been sent, or an error occurs, or a
-     *         timeout occurs.
-     * \param data The buffer to send to the host.
-     * \param length The length of the buffer to send.
-     * \return the number of written bytes on success (>=0) or -1 on failure
-     */
+    /** Send all the data to the remote host.
+    \param data The buffer to send to the host.
+    \param length The length of the buffer to send.
+    \return the number of written bytes on success (>=0) or -1 on failure
+    */
     int send_all(char* data, int length);
     
-    /*! \brief Receive data from the remote host. Return as soon as some data is
-     *         available.
-     * \param data The buffer in which to store the data received from the host.
-     * \param length The maximum length of the buffer.
-     * \return the number of received bytes on success (>=0) or -1 on failure
+    /** Receive data from the remote host.
+    \param data The buffer in which to store the data received from the host.
+    \param length The maximum length of the buffer.
+    \return the number of received bytes on success (>=0) or -1 on failure
      */
     int receive(char* data, int length);
     
-    /*! \brief Receive all the data from the remote host. This method continues to receive
-     *         data until either length bytes has been received, or an error occurs, or a
-     *         timeout occurs.
-     * \param data The buffer in which to store the data received from the host.
-     * \param length The maximum length of the buffer.
-     * \return the number of received bytes on success (>=0) or -1 on failure
-     */
+    /** Receive all the data from the remote host.
+    \param data The buffer in which to store the data received from the host.
+    \param length The maximum length of the buffer.
+    \return the number of received bytes on success (>=0) or -1 on failure
+    */
     int receive_all(char* data, int length);
 
 private: