From a9d6604ee9122b44ab8250e4b52b0ebd48c514e1 Mon Sep 17 00:00:00 2001
From: Jeffrey Walton <noloader@gmail.com>
Date: Fri, 12 Jan 2018 09:04:12 -0500
Subject: [PATCH] Update documentation

---
 misc.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/misc.h b/misc.h
index b9bc32a6..7401d92d 100644
--- a/misc.h
+++ b/misc.h
@@ -2405,6 +2405,11 @@ struct BlockGetAndPut
 	typedef PutBlock<T, B, PA> Put;
 };
 
+/// \brief Convert a word to a string
+/// \tparam T class or type
+/// \param value the word to convert
+/// \param order byte order
+/// \returns a string representing the value of the word
 template <class T>
 std::string WordToString(T value, ByteOrder order = BIG_ENDIAN_ORDER)
 {
@@ -2414,6 +2419,11 @@ std::string WordToString(T value, ByteOrder order = BIG_ENDIAN_ORDER)
 	return std::string((char *)&value, sizeof(value));
 }
 
+/// \brief Convert a string to a word
+/// \tparam T class or type
+/// \param str the string to convert
+/// \param order byte order
+/// \returns a word representing the value of the string
 template <class T>
 T StringToWord(const std::string &str, ByteOrder order = BIG_ENDIAN_ORDER)
 {