More docs fixing.

11 files changed, 32 insertions, 35 deletions

diff --git a/docs/carray_api.md b/docs/carray_api.md
index c8364b75..f70f49b7 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -1,7 +1,6 @@
-# Container type carray
+# Container type carray: Dynamic 1/2/3 Dimensional Array
 
-This describes the API of the unordered set type **carray**.
-1d, 2d and 3d arrays, allocated from heap in one single contiguous block of memory.
+This is 1D, 2D and 3D arrays, which are allocated from heap in one single contiguous block of memory.
 *carray3* may have sub-array "views" of *carray2* and *carray1* etc.
 
 ## Declaration
diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md
index 74e72f14..9d12abc9 100644
--- a/docs/cbitset_api.md
+++ b/docs/cbitset_api.md
@@ -1,6 +1,6 @@
-# Container type cbitset
+# Container type cbitset_t: Indexed Set of Boolean Values (Bits)
 
-This describes the API of string type **cbitset**.
+This describes the API of type **cbitset**.
 
 ## Types
 
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 64ee4c1f..9d2453d7 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -1,7 +1,6 @@
-# Container type clist
+# Container type clist: Circular Singly Linked List
 
-This describes the API of circular singly linked list type **clist**.
-Similar to c++ *std::forward_list*, but can do both *push_front()* and *push_back()* as well as *pop_front()*.
+This is similar to c++ *std::forward_list*, but can do both *push_front()* and *push_back()* as well as *pop_front()*.
 Also supports various *splice* functions and *merge sort*.
 
 ## Declaration
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index b38eace2..585f1e35 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -1,7 +1,6 @@
-# Container type cmap
+# Container type cmap: Unordered Map
 
-This describes the API of the unordered map type **cmap**. Elements are pairs of keys and mapped values.
-Implemented as open hashing without tombstones. Highly customizable and fast.
+Elements are pairs of keys and mapped values. Implemented as open hashing without tombstones. Highly customizable and fast.
 
 ## Declaration
 
@@ -159,11 +158,11 @@ The HEX of color BLACK is:[#000000]
 ```
 
 ### Example 2
-For illustration, this example uses a cmap with cstr_t as mapped value, instead of `using_strval(id, int)` macro.
+For illustration, this example uses a cmap with cstr_t as mapped value, instead of `using_cmap_strval(id, int)` macro.
 We must therefore pass new constructed cstr_t objects to the map when inserting, instead of `const char*` strings.
 ```c
-#include <stc/cstr.h>
-#include <stc/cmap.h>
+#include "stc/cstr.h"
+#include "stc/cmap.h"
 
 using_cmap(id, int, cstr_t, cstr_del);
 
diff --git a/docs/cpqueue_api.md b/docs/cpqueue_api.md
index 90623de9..1927b513 100644
--- a/docs/cpqueue_api.md
+++ b/docs/cpqueue_api.md
@@ -1,17 +1,17 @@
-# Container type cpqueue
+# Container type cpqueue: Priority Queue
 
-This describes the API of the queue type **cpqueue**.
+This describes the API of the queue type **cpqueue**. Implemented as a heap.
 
 ## Declaration
 
 ```c
-#define using_cpqueue(X, CType)
+#define using_cpqueue(X, CType, MaxOrMinHeap)
 ```
-The macro `using_cpqueue()` can be instantiated with 2 arguments in the global scope.
-**cpqueue** uses normally a **cvec** type as undelying implementation.
-Default values are given above for args not specified. `X` is a type tag name and
-will affect the names of all cpqueue types and methods. E.g. declaring `using_cpqueue(my, cvec_my);`,
-`X` should be replaced by `my` in all of the following documentation.
+The macro `using_cpqueue()` shall be instantiated in the global scope.
+**cpqueue** uses normally a **cvec** type as undelying implementation, specified as CType.
+The MaxOrMinHeap argument should be specified as a < or >, representing a max-heap or a min-heap.
+`X` is a type tag name and will affect the names of all cpqueue types and methods.
+Declaring `using_cpqueue(my, cvec_my);`, `X` should be replaced by `my` in the following documentation.
 
 ## Types
 
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 9b552653..db8bd901 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -1,4 +1,4 @@
-# Container type cqueue
+# Container type cqueue: Queue
 
 This describes the API of the queue type **cqueue**.
 
@@ -7,8 +7,8 @@ This describes the API of the queue type **cqueue**.
 ```c
 #define using_cqueue(X, CType)
 ```
-The macro `using_cqueue()` can be instantiated with 2 arguments in the global scope.
-**cqueue** uses normally a **clist** type as undelying implementation.
+The macro `using_cqueue()` shall be instantiated in the global scope.
+**cqueue** uses normally a **clist** type as underlying implementation, given as CType.
 Default values are given above for args not specified. `X` is a type tag name and
 will affect the names of all cqueue types and methods. E.g. declaring `using_cqueue(my, clist_my);`,
 `X` should be replaced by `my` in all of the following documentation.
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index 87bddcef..b645749b 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -1,11 +1,11 @@
-# Random number generators
+# Module crand: Pseudo Random Number Generators
 
-This describes the API of module **crandom**. Contains *pcg32* and a extremely fast *64-bit PRNG* inspired by *sfc64*.
-The RNG's can generate uniform and normal distributions.
+This describes the API of module **crand**. Contains *pcg32* and an extremely fast *64-bit PRNG* inspired by *sfc64*.
+The PRNG's can generate uniform and normal distributions.
 
 ## Types
 
-| crandom               | Type definition                             | Used to represent...                 |
+| Name                  | Type definition                             | Used to represent...                 |
 |:----------------------|:--------------------------------------------|:-------------------------------------|
 | `crand_rng32_t`       | `struct {uint64_t state[2];}`               | The crandom type                     |
 | `crand_uniform_i32_t` | `struct {int32_t offset; uint32_t range;}`  | The crandom element type             |
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 3a5d7fa7..6a4cb581 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -1,4 +1,4 @@
-# Container type cset

+# Container type cset: Unordered Set

 

 This describes the API of the unordered set type **cset**.

 Same base implementation as cmap, but contains and uses keys only.

diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 9cbd9d58..d6a0ae35 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -1,4 +1,4 @@
-# Container type cstack
+# Container type cstack: Stack
 
 This describes the API of the queue type **cstack**.
 
@@ -7,8 +7,8 @@ This describes the API of the queue type **cstack**.
 ```c
 #define using_cstack(X, CType)
 ```
-The macro `using_cstack()` can be instantiated with 2 arguments in the global scope.
-**cstack** uses normally a **cvec** type as undelying implementation.
+The macro `using_cstack()` shall be instantiated in the global scope.
+**cstack** uses normally a **cvec** type as underlying implementation, given as CType.
 Default values are given above for args not specified. `X` is a type tag name and
 will affect the names of all cstack types and methods. E.g. declaring `using_cstack(my, cvec_my);`,
 `X` should be replaced by `my` in all of the following documentation.
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 93680c71..20c0d0fc 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,4 +1,4 @@
-# String type cstr_t
+# Container type cstr_t: String
 
 This describes the API of string type **cstr_t**.
 
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 9660f540..0ba81fcd 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -1,4 +1,4 @@
-# Container type cvec
+# Container type cvec: Vector
 
 This describes the API of vector type **cvec**.