X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=hashtable.h;h=8302000b03e9f9946eb064a8c5c61ca1d8f27b44;hb=718fed530a17d55ab479921e8dffebea4f98cbdf;hp=b4054ec8c71263c0210e216fe5befef329ef4ddc;hpb=88c15be7ff68a7b437fd78d6e5e0ede7aa1dbf6e;p=c11tester.git

diff --git a/hashtable.h b/hashtable.h
index b4054ec8..8302000b 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);