From: Ralph Ronnquist <ralph.ronnquist@gmail.com>
Date: Wed, 6 Jul 2022 04:57:40 +0000 (+1000)
Subject: editorials for doxygen
X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=813b52397a92922f2540a41c9076a77ca93e1a48;p=rrq%2Frrqmisc.git

editorials for doxygen
---

diff --git a/vector/hashvector.h b/vector/hashvector.h
index a3810f9..a4f9f7f 100644
--- a/vector/hashvector.h
+++ b/vector/hashvector.h
@@ -32,6 +32,7 @@
  * hashvector combines a vector (for contents) with fill and hole
  * counters, and itemkeyfun callback functions for abstracting items
  * as being pairs of key and payload.
+ * \extends vector
  */
 typedef struct {
     /**
diff --git a/vector/relation.h b/vector/relation.h
index c589176..af0756c 100644
--- a/vector/relation.h
+++ b/vector/relation.h
@@ -5,11 +5,12 @@
 #include <tupleitem.h>
 
 /**
- * A relation is an implementation of a tuple set with (optinal) key
+ * A relation is an implementation of a tuple set with (optional) key
  * constraints. The store is a hashvector whose "type" is a
  * tupleschema that defines the columns. The key constraints are
  * represented as additional hashvectors whose tupleschemas are clones
  * of the column schema with some columns excluded.
+ * \extends hashvector
  */
 typedef struct {
     /**
diff --git a/vector/tupleitem.h b/vector/tupleitem.h
index 889b875..59589e7 100644
--- a/vector/tupleitem.h
+++ b/vector/tupleitem.h
@@ -14,6 +14,7 @@ typedef void *tuple[];
  * macro \ref TUPLEITEMINIT may be used to initialize particular
  * tupleschema records, which each become tupleitem declaration for
  * its particular arity and parts declarations
+ * \extends itemkeyfun
  */
 typedef struct {
     /**
diff --git a/vector/vector.h b/vector/vector.h
index 33cf96a..3cbd935 100644
--- a/vector/vector.h
+++ b/vector/vector.h
@@ -67,9 +67,7 @@ enum vector_variant {
  */
 typedef struct {
     /**
-     * The indexing variant. 0 = 8-bit, 1 = 4-bit, and 2 = 2-bit
-     * indexing parts. This gives 256, 16 or 4 slots per index page.
-     * Note that variant should not be changed after initialization.
+     * The indexing variant.
      */
     enum vector_variant variant;