Diff: data/HTTPFile.h

Revision:

32:7b9919d59194

Parent:

25:76084defa790

Child:

33:d4d1475bafc0

--- a/data/HTTPFile.h	Sat Jul 26 19:47:36 2014 +0000
+++ b/data/HTTPFile.h	Sat Oct 11 17:26:04 2014 +0000
@@ -24,23 +24,26 @@
         virtual void writeReset();
         
         /** Write a piece of data transmitted by the server
-        * @param buf Pointer to the buffer from which to copy the data
-        * @param len Length of the buffer
+        * @param[in] buf Pointer to the buffer from which to copy the data
+        * @param[in] len Length of the buffer
+        * @returns number of bytes written.
         */
         virtual int write(const char* buf, size_t len);
         
         /** Set MIME type
-        * @param type Internet media type from Content-Type header
+        * @param[in] type Internet media type from Content-Type header
         */
         virtual void setDataType(const char* type);
         
         /** Determine whether the data is chunked
         *  Recovered from Transfer-Encoding header
+        * @param[in] chunked indicates the transfer is chunked.
         */
         virtual void setIsChunked(bool chunked);
         
         /** If the data is not chunked, set its size
         * From Content-Length header
+        * @param[in] len defines the size of the non-chunked transfer.
         */
         virtual void setDataLen(size_t len);
     private: