summaryrefslogtreecommitdiffhomepage
path: root/docs/cvec_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-11-30 19:00:36 +0100
committerTyge Løvset <[email protected]>2020-11-30 19:00:36 +0100
commit2eb2033e41b04a137f9cf950ff313cfe32d2b049 (patch)
treed4be8c23fb8791ac843498c4a708cf67f79c92e8 /docs/cvec_api.md
parentf27f9876f000bc4ca0683aa32e737d9daa1ceb8e (diff)
downloadSTC-modified-2eb2033e41b04a137f9cf950ff313cfe32d2b049.tar.gz
STC-modified-2eb2033e41b04a137f9cf950ff313cfe32d2b049.zip
Added cmap api docs.
Diffstat (limited to 'docs/cvec_api.md')
-rw-r--r--docs/cvec_api.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 79c143ee..34d055c2 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -16,10 +16,11 @@ This describes the API of vector type **cvec**.
valueFromRaw=c_default_from_raw)
```
The macro `using_cvec()` can be instantiated with 2, 3, 4, or 7 arguments in the global scope.
-Defaults are given above for args not specified. Note that `z` can be any name, it's a tag and
-will affect the names of all cvec types and methods, e.g. for `using_cvec(my, int);` `$` should
-be replaced by `my` in all of the following documentation. `using_cvec_str()` is a predefined
-macro for `using_cvec(str, cstr_t, ...)`.
+Defaults values are given above for args not specified. `$` is a type tag name and
+will affect the names of all cvec types and methods. E.g. declaring `using_cvec(my, int);`, `$` should
+be replaced by `my` in all of the following documentation.
+
+`using_cvec_str()` is a predefined macro for `using_cvec(str, cstr_t, ...)`.
## Types
@@ -36,9 +37,10 @@ macro for `using_cvec(str, cstr_t, ...)`.
| Name | Value |
|:---------------------------|:-----------------|
| `cvec_inits` | `{NULL}` |
-| `cvec_size(v) | |
-| `cvec_capacity(v)` | |
-| `cvec_empty(v)` | |
+| `cvec_empty(vec)` | |
+| `cvec_size(vec)` | |
+| `cvec_capacity(vec)` | |
+
## Header file