editorials for doxygen
authorRalph Ronnquist <ralph.ronnquist@gmail.com>
Wed, 6 Jul 2022 04:57:40 +0000 (14:57 +1000)
committerRalph Ronnquist <ralph.ronnquist@gmail.com>
Wed, 6 Jul 2022 04:57:40 +0000 (14:57 +1000)
vector/hashvector.h
vector/relation.h
vector/tupleitem.h
vector/vector.h

index a3810f9da2440ab738701306da842d0571793e5f..a4f9f7f1676034e86ef4f127b68db4fbbc8cda30 100644 (file)
@@ -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 {
     /**
index c589176d3387601fae18fc29ad57ba954740ba26..af0756cd09265c2e67196d7feff625bc38cf9c75 100644 (file)
@@ -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 {
     /**
index 889b875f29ab816a7795602654f9ca3c5fac3e1f..59589e7c90555f96dd4e521610eea0f890e48e2f 100644 (file)
@@ -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 {
     /**
index 33cf96a46ce26919d927ca019891c83b5cae5bbb..3cbd93562ad9bf59183271c3c5e4b4475809bb36 100644 (file)
@@ -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;