summaryrefslogtreecommitdiffhomepage
path: root/docs/cstack_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-03 11:38:40 +0100
committerTyge Løvset <[email protected]>2020-12-03 11:38:40 +0100
commit0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11 (patch)
treef6fa75a63428c2840e50b1c0133b248bc66ce870 /docs/cstack_api.md
parent2afda956b19186c6f4306d43429948a6f7f40d07 (diff)
downloadSTC-modified-0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11.tar.gz
STC-modified-0583a9cf43ed7f771e6ade5cadb9743b0b4b6c11.zip
More docs fixing.
Diffstat (limited to 'docs/cstack_api.md')
-rw-r--r--docs/cstack_api.md6
1 files changed, 3 insertions, 3 deletions
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.