Diff: LPC2368/services/http/client/data/HTTPFile.h

Revision:

5:d0be6af2d1db

Parent:

0:a828ace1f38d

--- a/LPC2368/services/http/client/data/HTTPFile.h	Fri Jul 09 14:35:21 2010 +0000
+++ b/LPC2368/services/http/client/data/HTTPFile.h	Thu Aug 05 15:09:46 2010 +0000
@@ -21,18 +21,38 @@
 THE SOFTWARE.
 */
 
+/** \file
+HTTP File data source/sink header file
+*/
+
 #ifndef HTTP_FILE_H
 #define HTTP_FILE_H
 
 #include "../HTTPData.h"
 #include "mbed.h"
 
+///HTTP Client data container for files
+/**
+This class provides file access/storage for HTTP requests and responses' data payloads.
+
+
+*/
 class HTTPFile : public HTTPData //Read or Write data from a file
 {
 public:
+  ///Instantiates data source/sink with file in param.
+  /**
+  Uses file at path @a path.
+  It will be opened when some data has to be read/written from/to it and closed when this operation is complete or on destruction of the instance.
+  Note that the file will be opened with mode "w" for writing and mode "r" for reading, so the file will be cleared between each request if you are using it for writing.
+  
+  @note
+  Note that to use this you must instantiate a proper file system (such as the LocalFileSystem or the SDFileSystem).
+  */
   HTTPFile(const char* path);
   virtual ~HTTPFile();
   
+  ///Forces file closure
   virtual void clear();
 
 protected: