Comment-only changes.

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4934

diff --git a/include/pub_tool_oset.h b/include/pub_tool_oset.h
index 435f67901365a428c46e5a1774d09ebeb8a9a57e..6559ce8fa3d5da17cecb3f626fb5626ad7fdb410 100644 (file)
--- a/include/pub_tool_oset.h
+++ b/include/pub_tool_oset.h
@@ -75,7 +75,6 @@ typedef void  (*OSetFree_t)  ( void* p );
 
 // * Create: allocates an initialises the OSet.  Arguments:
 //   - keyOff    The offset of the key within the element.
-//   - elemSize  The size of the element.
 //   - cmp       The comparison function between keys and elements, or NULL
 //               if the OSet should use fast comparisons.
 //   - alloc     The allocation function used for allocating the OSet itself;
@@ -110,6 +109,10 @@ extern void  VG_(OSet_FreeNode)  ( OSet* os, void* elem );
 /*--- Operations on OSets                                          ---*/
 /*--------------------------------------------------------------------*/
 
+// In everything that follows, the parameter 'key' is always the *address*
+// of the key, and 'elem' is *address* of the elem, as are the return values
+// of the functions that return elems.
+//
 // * Size: The number of elements in the set.
 //
 // * Contains: Determines if any element in the OSet matches the key.