From 9e438bd5e9eec9cc1fb9d158f394f8998fd10cf2 Mon Sep 17 00:00:00 2001
From: Brian Norris <banorris@uci.edu>
Date: Fri, 10 Aug 2012 18:11:12 -0700
Subject: [PATCH] hashtable: document get_safe_ptr()

---
 hashtable.h | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/hashtable.h b/hashtable.h
index b4054ec..8302000 100644
--- a/hashtable.h
+++ b/hashtable.h
@@ -152,7 +152,16 @@ template<typename _Key, typename _Val, typename _KeyInt, int _Shift=0, void * (*
 		size++;
 	}
 
-	/** Put a key entry into the table. */
+	/**
+	 * @brief Get a valid pointer to a value corresponding to a given key
+	 *
+	 * Ensure that key is present in the hash table, then return a pointer
+	 * to its value bin. This may require either creating a new bin for
+	 * this key (with a default-constructed value) or simply locating and
+	 * returning a pointer to an existing value.
+	 * @param key The key to check
+	 * @return A pointer to the value in the table
+	 */
 	_Val * get_safe_ptr(_Key key) {
 		if (size > threshold)
 			resize(capacity << 1);
-- 
2.34.1