diff options
| author | Tyge Løvset <[email protected]> | 2020-11-30 16:24:13 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-11-30 16:24:13 +0100 |
| commit | 370f14c08fc80a202c69f6c83fde5313bfa8c69d (patch) | |
| tree | 1e984f5a590e6d16e974067fd805bd0bc19a734f /docs/cvec_api.md | |
| parent | 86e4768e3c46879421772147b377395fd232a7cd (diff) | |
| download | STC-modified-370f14c08fc80a202c69f6c83fde5313bfa8c69d.tar.gz STC-modified-370f14c08fc80a202c69f6c83fde5313bfa8c69d.zip | |
Minors docs.
Diffstat (limited to 'docs/cvec_api.md')
| -rw-r--r-- | docs/cvec_api.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md index 601eddb1..568c5129 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -4,7 +4,7 @@ UNDER CONSTRUCTION! This describes the API of vector type **cvec**. -## Instantiation +## Declaration ```c #define using_cvec_str() @@ -15,10 +15,11 @@ This describes the API of vector type **cvec**. valueToRaw=c_default_to_raw, valueFromRaw=c_default_from_raw) ``` -The macro `using_cvec()` can be instantiated with 2, 3, 4, or 7 arguments. 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);` `_z` should be replaced by `_my` in all the following documentation. -`using_cvec_str()` is a predefined macro for `using_cvec(str, cstr_t, ...)`. +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);` `_z` 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 @@ -53,7 +54,7 @@ All cvec definitions and prototypes may be included in your C source file by inc The interface for cvec: ```c cvec_z cvec_z_init(void); -cvec_z cvec_z_with_size(size_t size, Value null_val); +cvec_z cvec_z_with_size(size_t size, Value fill_val); cvec_z cvec_z_with_capacity(size_t size); void cvec_z_clear(cvec_z* self); |
