X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;ds=inline;f=vector%2FHashVector.h;h=387f7ce53cbe3782fee880af84e5f6c0af71a238;hb=58de9483c458a25a691d648ce13b81227c327d03;hp=0b4a0f6c19c38c7fac86a3a1c93448cb79b6fedd;hpb=e938f8c45fd191d96da48f65262e4efcfada7805;p=rrq%2Frrqmisc.git

diff --git a/vector/HashVector.h b/vector/HashVector.h
index 0b4a0f6..387f7ce 100644
--- a/vector/HashVector.h
+++ b/vector/HashVector.h
@@ -73,7 +73,7 @@ typedef struct {
 #define HV_HOLE ((void*) 1)
 
 /**
- * \brief Find the keyed item.
+ * \brief Lookup the first item with the given key.
  *
  * \param hv is the \ref HashVector concerned.
  *
@@ -86,18 +86,21 @@ typedef struct {
 void *HashVector_find(HashVector *hv,void *key);
 
 /**
- * \brief Scan the table for th next key-matching item at or after the
- * given index.
+ * \brief Scan the table for any subsequent item that admits to the
+ * given partial key.
  *
  * \param hv is the \ref HashVector concerned.
  *
  * \param index is a pointer to the index to advance.
  * \
- * \param key is the Query key
+ * \param key is the query key
  *
  * \returns the next matching item, or \b 0 if none, with the index
  * updated.
  *
+ * This function is used where the query key doesn't fully identify an
+ * item, and is thus a partial key that 
+ *
  * \related HashVector
  */
 extern void *HashVector_next(HashVector *hv,VectorIndex *i,void *key);