summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md2
-rw-r--r--docs/cbitset_api.md2
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/copt_api.md2
-rw-r--r--docs/cpqueue_api.md2
-rw-r--r--docs/cptr_api.md2
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/crand_api.md2
-rw-r--r--docs/cset_api.md2
-rw-r--r--docs/cstack_api.md2
-rw-r--r--docs/cstr_api.md2
-rw-r--r--docs/cvec_api.md2
12 files changed, 12 insertions, 12 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 809bb2c9..9d80ad13 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -1,4 +1,4 @@
-# Container carray: Dynamic 1/2/3 Dimensional Array
+# Container [carray](../stc/carray.h): Dynamic 1/2/3 Dimensional Array
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.
diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md
index f6878bea..a9d7d583 100644
--- a/docs/cbitset_api.md
+++ b/docs/cbitset_api.md
@@ -1,4 +1,4 @@
-# Container cbitset_t: Indexed Bitset
+# Container [cbitset](../stc/cbitset.h): Indexed Bitset
This describes the API of type **cbitset**.
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 9cd40555..197d4b92 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -1,4 +1,4 @@
-# Container cmap: Unordered Map
+# Container [cmap](../stc/cmap.h): Unordered Map
Elements are pairs of keys and mapped values. Implemented as open hashing without tombstones. Highly customizable and fast.
diff --git a/docs/copt_api.md b/docs/copt_api.md
index e91c21ea..819ac7b3 100644
--- a/docs/copt_api.md
+++ b/docs/copt_api.md
@@ -1,4 +1,4 @@
-# Introduction
+# Module [copt](../stc/copt.h): Command line argument parsing
This describes the API of string type *copt_get()* function for command line argument parsing.
diff --git a/docs/cpqueue_api.md b/docs/cpqueue_api.md
index 09cca96d..d0fa61cb 100644
--- a/docs/cpqueue_api.md
+++ b/docs/cpqueue_api.md
@@ -1,4 +1,4 @@
-# Container cpqueue: Priority Queue
+# Container [cpqueue](../stc/cpqueue.h): Priority Queue
This describes the API of the queue type **cpqueue**. Implemented as a heap.
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 4f02d20f..6273833e 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -1,4 +1,4 @@
-# Module cptr: Smart Pointers
+# Module [cptr](../stc/cptr.h): Smart Pointers
This describes the API of the pointer type **cptr** and the shared pointer type **csptr**. Type **cptr** is meant to be used like a c++ *std::unique_ptr*, while **csptr** is similar to c++ *std::shared_ptr*.
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 6b7f5823..b5cbfe29 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -1,4 +1,4 @@
-# Container cqueue: Queue
+# Container [cqueue](../stc/cqueue.h): Queue
This describes the API of the queue type **cqueue**.
diff --git a/docs/crand_api.md b/docs/crand_api.md
index 1a26519c..df452a49 100644
--- a/docs/crand_api.md
+++ b/docs/crand_api.md
@@ -1,4 +1,4 @@
-# Module crand: Pseudo Random Number Generators
+# Module [crand](../stc/crand.h): Pseudo Random Number Generators
This describes the API of module **crand**. It contains a *64-bit PRNG*, and can generate
bounded uniform and normal distributed random numbers.
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 1a4bf9f8..3e63f383 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -1,4 +1,4 @@
-# Container cset: Unordered Set
+# Container [cset](../stc/cmap.h): 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 c7805ab9..bf707d83 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -1,4 +1,4 @@
-# Container cstack: Stack
+# Container [cstack](../stc/cstack.h): Stack
This describes the API of the queue type **cstack**.
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index a8a59388..97fc4032 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,4 +1,4 @@
-# Container cstr_t: String
+# Container [cstr](../stc/cstr.h): String
This describes the API of string type **cstr_t**.
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index fc3697ee..d33a4d42 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -1,4 +1,4 @@
-# Container cvec: Vector
+# Container [cvec](../stc/cvec.h): Vector
This describes the API of vector type **cvec**.