version 0.3.33
[fms.git] / include / freenet / fcpv2.h
index 1f033a9..2a64958 100644 (file)
@@ -115,6 +115,8 @@ public:
                \brief Gets the string representing this message in FCP\r
 \r
                This string is what is actually sent/received from the node through FCP\r
+\r
+               \return The FCP message string\r
        */\r
        const std::string GetFCPString() const;\r
 \r
@@ -138,20 +140,20 @@ public:
        /**\r
                \brief Construct connection with an existing socket\r
 \r
-               \param sock An existing socket connection to a Freenet node\r
+               \param sock An existing open socket connection to a Freenet node\r
        */\r
        Connection(const int sock);\r
        /**\r
-               \brief Default constructor\r
+               \brief Default destructor\r
 \r
-               The deconstructor will close the connection if it is open\r
+               The destructor will close the connection if it is open\r
        */\r
        ~Connection();\r
 \r
        /**\r
                \brief Creates an FCP connection to a Freenet node\r
 \r
-               If the instaciated object has an existing connection open, it will be closed.\r
+               If the instanciated object has an existing connection open, it will be closed.\r
 \r
                \param fcphost The IP Address, hostname, FQDN, or other resolvable name that points to the Freenet node\r
                \param fcpport The port that the Freenet node is listening for FCP connections on\r
@@ -265,7 +267,7 @@ public:
                \brief Waits until the receive buffer contains a specified number of bytes\r
                \r
                This will continuously call Update until either the specific number of bytes have been received,\r
-               or the connection becomes disconnected\r
+               or the connection becomes disconnected.\r
                \r
                \param ms The number of milliseconds for each call to Update\r
                \param len The number of bytes to wait for\r