From 2eb2033e41b04a137f9cf950ff313cfe32d2b049 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Mon, 30 Nov 2020 19:00:36 +0100 Subject: Added cmap api docs. --- docs/cvec_api.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'docs/cvec_api.md') 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 -- cgit v1.2.3