Clean up TODOs in OCUtilities

[platform/upstream/iotivity.git] / resource / include / OCUtilities.h

diff --git a/resource/include/OCUtilities.h b/resource/include/OCUtilities.h
index 1c083df..82cccd9 100644 (file)
--- a/resource/include/OCUtilities.h
+++ b/resource/include/OCUtilities.h
@@ -35,20 +35,14 @@ namespace OC {
 
         typedef std::map<std::string, std::string> QueryParamsKeyVal;
         /*
-         * @brief Helper function to get query parameter from a URI
-         * @remarks      Its okay to return a copy of the container.\
-         *               The size is not expected to be huge.
-         * @remarks      Temporary: The URI must strictly have\
-         *               coap as the protocol in the fully qualified URI\
-         *               e.g., coap://1.2.3.4:5657/foo?bar=0)
-         * @remarks      If a separate class for URI parser is needed,\
-         *               please talk to Erich Keane.
-         * @todo         If more URI elements need to be parsed,\
-         *               please move the common parsing logic to a
-         *               different function
+         * @brief helper function that parses the query parameters component
+         * of a URI into a key-value map.  This function expects the uri
+         * parameter to contain the query parameters component of a URI
+         * (everything after the '?', excluding anything anchors).
+         *
+         * Note that output will not perform URL decoding
          */
         QueryParamsKeyVal getQueryParams(const std::string& uri);
-
     }
 }