aboutsummaryrefslogtreecommitdiff
path: root/include/pub_tool_oset.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/pub_tool_oset.h')
-rw-r--r--include/pub_tool_oset.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/include/pub_tool_oset.h b/include/pub_tool_oset.h
index 435f67901..6559ce8fa 100644
--- 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.