summaryrefslogtreecommitdiffhomepage
path: root/docs/cstack_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-03 20:56:26 +0100
committerTyge Løvset <[email protected]>2020-12-03 20:56:26 +0100
commit3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e (patch)
treefa1584e0023fc553b17511bf4b186ba388939be6 /docs/cstack_api.md
parent870a601a62c804f9d15efe5856cc6018b076dfe6 (diff)
downloadSTC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.tar.gz
STC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.zip
More docs descriptions.
Diffstat (limited to 'docs/cstack_api.md')
-rw-r--r--docs/cstack_api.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 898b5d8f..433428bf 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -7,10 +7,9 @@ This describes the API of the queue type **cstack**.
```c
#define using_cstack(X, ctype)
```
-The macro `using_cstack()` must 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);`,
+The macro `using_cstack()` must be instantiated in the global scope. **cstack** uses normally
+a **cvec** type as underlying implementation, given as `ctype`. `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.
## Types
@@ -28,7 +27,7 @@ will affect the names of all cstack types and methods. E.g. declaring `using_cst
All cstack definitions and prototypes may be included in your C source file by including a single header file.
```c
-#include "stc/cstack.h"
+#include "stc/cstack.h" /* includes default underlying implementation header cvec.h */
```
## Methods