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

Revision:

9:c79fa4034f5b

Parent:

0:632c9925f013

Child:

10:d098e9192450

--- a/services/http/client/data/HTTPFile.h	Wed Jul 28 12:45:32 2010 +0000
+++ b/services/http/client/data/HTTPFile.h	Thu Aug 05 14:32:43 2010 +0000
@@ -21,18 +21,33 @@
 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 @param 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.
+  */
   HTTPFile(const char* path);
   virtual ~HTTPFile();
   
+  ///Forces file closure
   virtual void clear();
 
 protected: