Revert back cbor related patches.

[platform/upstream/iotivity.git] / resource / csdk / security / include / srmutility.h

diff --git a/resource/csdk/security/include/srmutility.h b/resource/csdk/security/include/srmutility.h
index 029a41b..80548f0 100644 (file)
--- a/resource/csdk/security/include/srmutility.h
+++ b/resource/csdk/security/include/srmutility.h
@@ -33,76 +33,86 @@ extern "C"
 }
 #endif
 
+
 #ifdef __cplusplus
 extern "C" {
 #endif // __cplusplus
 
+
 typedef struct OicParseQueryIter OicParseQueryIter_t;
 
 /**
- * OicRestQueryIter data structure is used for book-keeping
- * sub-REST query's attribute's and value's, starting location &
- * length between calls to GetNextQuery(). This struct needs
- * to be first initialized with ParseQueryIterInit().
+ * @brief   OicRestQueryIter data structure is used for book-keeping
+ *          sub-REST query's attribute's and value's, starting location &
+ *          length between calls to GetNextQuery(). This struct needs
+ *          to be first initialized with ParseQueryIterInit().
  *
  */
 struct OicParseQueryIter
 {
-    unsigned char * attrPos;    /**< stating location of attribute. */
-    size_t attrLen;             /**< length of the attribute. */
-    unsigned char * valPos;     /**< starting location of value. */
-    size_t valLen;              /**< length of the value. */
-    coap_parse_iterator_t pi;   /**< coap struct for tokenizing the query.*/
+    unsigned char * attrPos;    /**<stating location of attribute */
+    size_t attrLen;             /**<length of the attribute */
+    unsigned char * valPos;     /**<starting location of value*/
+    size_t valLen;              /**<length of the value*/
+    coap_parse_iterator_t pi;   /**<coap struct for tokenizing the query*/
 };
 
 /**
- * Macro to verify success of operation.
+ * @def VERIFY_SUCCESS
+ * @brief Macro to verify success of operation.
  * eg: VERIFY_SUCCESS(TAG, OC_STACK_OK == foo(), ERROR);
  * @note Invoking function must define "exit:" label for goto functionality to work correctly.
+ *
  */
 #define VERIFY_SUCCESS(tag, op, logLevel) do{ if (!(op)) \
             {OIC_LOG((logLevel), tag, #op " failed!!"); goto exit; } }while(0)
 
 /**
- * Macro to verify argument is not equal to NULL.
+ * @def VERIFY_NON_NULL
+ * @brief Macro to verify argument is not equal to NULL.
  * eg: VERIFY_NON_NULL(TAG, ptrData, ERROR);
  * @note Invoking function must define "exit:" label for goto functionality to work correctly.
+ *
  */
 #define VERIFY_NON_NULL(tag, arg, logLevel) do{ if (NULL == (arg)) \
             { OIC_LOG((logLevel), tag, #arg " is NULL"); goto exit; } }while(0)
 
 /**
- * This method initializes the @ref OicParseQueryIter_t struct.
+ * This method initializes the OicParseQueryIter_t struct
+ *
+ *@param query     - REST query, to be parsed
+ *@param parseIter - OicParseQueryIter_t struct, to be initialized
  *
- * @param query is the REST query, to be parsed.
- * @param parseIter is the @ref OicParseQueryIter_t struct, to be initialized based on the query.
  */
-void ParseQueryIterInit(const unsigned char * query, OicParseQueryIter_t * parseIter);
+void ParseQueryIterInit(unsigned char * query, OicParseQueryIter_t * parseIter);
+
 
 /**
- * This method fills the @ref OicParseQueryIter_t struct with next REST query's
- * attribute's and value's information.
+ * This method fills the OicParseQueryIter_t struct with next REST query's
+ * attribute's and value's information
  *
- * @param parseIter is the @ref OicParseQueryIter_t struct, has next query's attribute's
- *  & value's info.
+ *@param parseIter - OicParseQueryIter_t struct, has next query's attribute's & value's info
  *
- * @return reference to the @ref OicParseQueryIter_t if it has parsed query info, else
- * NULL if it has no query to parse.
+ * @retval
+ *     OicParseQueryIter_t *  - has parsed query info
+ *     NULL                   - has no query to parse
  */
 OicParseQueryIter_t * GetNextQuery(OicParseQueryIter_t * parseIter);
 
+
+
 /**
- * This method acts as a helper function for JSON unmarshalling by various SVR's.
+ * This method acts as a helper funtion for JSON unmarshalling by various SVR's.
  *
- * @param jsonRoot point to the root JSON node containing the OicUuid array.
- * @param arrayItem is the name of the JSON OicUuid array item.
- * @param numUuids is the pointer to the number of OicUuid's available in JSON array.
- * @param uuids is the pointer to the array of OicUuid's.
+ * @param jsonRoot  - root JSON node containing the OicUuid array
+ * @param arrayItem - name of the JSON OicUuid array item
+ * @param numUuids  - pointer to the number of OicUuid's available in JSON array
+ * @param uuids     - pointer to the array of OicUuid's
  *
  * @return ::OC_STACK_OK on success, some other value upon failure.
  */
-OCStackResult AddUuidArray(const cJSON* jsonRoot, const char* arrayItem,
-                           size_t *numUuids, OicUuid_t** uuids);
+OCStackResult AddUuidArray(cJSON* jsonRoot, const char* arrayItem,
+                           size_t *numUuids, OicUuid_t** uuids );
 
 /**
  * Function to getting string of ownership transfer method