Diff: api/DataWrapper.h

Revision:

26:b06a19916f05

Parent:

25:1fc958ac14d1

Child:

27:eb6818ad257a

--- a/api/DataWrapper.h	Fri Mar 20 05:32:16 2015 +0000
+++ b/api/DataWrapper.h	Fri Mar 20 05:55:22 2015 +0000
@@ -1,6 +1,6 @@
 /**
  * @file    DataWrapper.h
- * @brief   mbed CoAP Endpoint Data Wrapper class
+ * @brief   mbed CoAP Endpoint Data Wrapper class (header)
  * @author  Doug Anson
  * @version 1.0
  * @see
@@ -30,16 +30,20 @@
     public:
         /**
         Default constructor
+        @param data input the buffer to use for operations
+        @param data_length input the data length
         */
         DataWrapper(uint8_t *data,int data_length);
         
         /**
         Default constructor (alloc)
+        @param data_length input the data length (alloc)
         */
         DataWrapper(int data_length);
         
         /**
         Default copy constructor
+        @param data input the DataWrapper to copy
         */
         DataWrapper(const DataWrapper &data);
         
@@ -49,12 +53,16 @@
         virtual ~DataWrapper();
         
         /**
-        Wrap the data
+        Wrap the data (trivial in base class)
+        @param data input the data to wrap
+        @param data_length input the length of the data to wrap
         */
         virtual void wrap(uint8_t *data,int data_length);
         
         /**
-        Unwrap the data
+        Unwrap the data (trivial in base class)
+        @param data input the data to unwrap
+        @param data_length input the length of the data to unwrap
         */
         virtual void unwrap(uint8_t *data,int data_length);
         
@@ -74,6 +82,7 @@
         Reset the wrapper
         */
         void reset();
+        
     protected:
         uint8_t *m_data;