docs: Updating doxygen comments and minor update to normalize API
Change-Id: I24686acc36f372ee2eddffaaa6c104f964ceeca4
Refs: #1299
diff --git a/src/util/string-helper.hpp b/src/util/string-helper.hpp
index b4878ae..13b0b31 100644
--- a/src/util/string-helper.hpp
+++ b/src/util/string-helper.hpp
@@ -23,9 +23,10 @@
static const char* WHITESPACE_CHARS = " \n\r\t";
/**
- * Return the hex representation of the bytes in array.
- * @param array The array of bytes.
- * @return Hex string.
+ * @brief Return the hex representation of the bytes in array
+ *
+ * @param array The array of bytes
+ * @param arraySize Size of the array
*/
inline std::string
toHex(const uint8_t* array, size_t arraySize)
@@ -46,8 +47,7 @@
}
/**
- * Modify str in place to erase whitespace on the left.
- * @param str
+ * @brief Modify str in place to erase whitespace on the left
*/
inline void
trimLeft(std::string& str)
@@ -63,8 +63,7 @@
}
/**
- * Modify str in place to erase whitespace on the right.
- * @param str
+ * @brief Modify str in place to erase whitespace on the right
*/
inline void
trimRight(std::string& str)
@@ -80,8 +79,7 @@
}
/**
- * Modify str in place to erase whitespace on the left and right.
- * @param str
+ * @brief Modify str in place to erase whitespace on the left and right
*/
inline void
trim(std::string& str)
@@ -91,9 +89,7 @@
}
/**
- * Convert the hex character to an integer from 0 to 15, or -1 if not a hex character.
- * @param c
- * @return
+ * @brief Convert the hex character to an integer from 0 to 15, or -1 if not a hex character
*/
inline int
fromHexChar(uint8_t c)
@@ -109,8 +105,7 @@
}
/**
- * Return a copy of str, converting each escaped "%XX" to the char value.
- * @param str
+ * @brief Return a copy of str, converting each escaped "%XX" to the char value
*/
inline std::string
unescape(const std::string& str)