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

Revision:

9:c79fa4034f5b

Parent:

0:632c9925f013

Child:

11:da4498f591ee

--- a/services/http/client/data/HTTPMap.h	Wed Jul 28 12:45:32 2010 +0000
+++ b/services/http/client/data/HTTPMap.h	Thu Aug 05 14:32:43 2010 +0000
@@ -21,6 +21,10 @@
 THE SOFTWARE.
 */
 
+/** \file
+HTTP Map data source/sink header file
+*/
+
 #ifndef HTTP_MAP_H
 #define HTTP_MAP_H
 
@@ -32,9 +36,22 @@
 
 typedef map<string, string> Dictionary;
 
+///HTTP Client data container for key/value pairs
+/**
+This class simplifies the use of key/value pairs requests and responses used widely among web APIs.
+Note that HTTPMap inherits from std::map<std::string,std::string>.
+You can therefore use any public method of that class, including the square brackets operator ( [ ] ) to access a value.
+
+The data is encoded or decoded to/from a key/value pairs-formatted string, after url-encoding/decoding.
+*/
 class HTTPMap : public HTTPData, public Dictionary //Key/Value pairs
 {
 public:
+  ///Instantiates map
+  /**
+  @param keyValueSep Key/Value separator (defaults to "=")
+  @param pairSep Pairs separator (defaults to "&")
+  */
   HTTPMap(const string& keyValueSep = "=", const string& pairSep = "&");
   virtual ~HTTPMap();