Rob Toulson / HTTPClient

RobT's fork of HTTPClient library

Fork of HTTPClient_ToBeRemoved by Donatien Garnier

Diff: data/HTTPText.h

Revision:
7:d97a4fc01c86
Parent:
6:3d3824893be1
--- a/data/HTTPText.h	Thu Apr 19 09:19:58 2012 +0000
+++ b/data/HTTPText.h	Thu Apr 19 09:52:54 2012 +0000
@@ -27,10 +27,20 @@
 
 #include "../IHTTPData.h"
 
+/** A data endopint to store text
+*/
 class HTTPText : public IHTTPDataIn, public IHTTPDataOut
 {
 public:
+  /** Create an HTTPText instance for output
+   * @param str String to be transmitted
+   */
   HTTPText(char* str);
+
+  /** Create an HTTPText instance for input
+   * @param str Buffer to store the incoming string
+   * @param size Size of the buffer
+   */
   HTTPText(char* str, size_t size);
 
 protected: