diff options
| -rw-r--r-- | docs/clist_api.md | 11 | ||||
| -rw-r--r-- | docs/cstr_api.md | 3 | ||||
| -rw-r--r-- | docs/cvec_api.md | 13 |
3 files changed, 13 insertions, 14 deletions
diff --git a/docs/clist_api.md b/docs/clist_api.md index 9ade0bf1..58327b37 100644 --- a/docs/clist_api.md +++ b/docs/clist_api.md @@ -4,7 +4,7 @@ UNDER CONSTRUCTION! This describes the API of circular singly linked list type **clist**. -## Instantiation +## Declaration ```c #define using_clist_str() @@ -15,10 +15,11 @@ This describes the API of circular singly linked list type **clist**. valueToRaw=c_default_to_raw, valueFromRaw=c_default_from_raw) ``` -The macro `using_clist()` 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 clist types and methods, -e.g. for `using_clist(my, int);` `_z` should be replaced by `_my` in all the following documentation. -`using_clist_str()` is a predefined macro for `using_clist(str, cstr_t, ...)`. +The macro `using_clist()` 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 clist types and methods, e.g. for `using_clist(my, int);` `_z` should +be replaced by `_my` in all of the following documentation. `using_clist_str()` is a predefined +macro for `using_clist(str, cstr_t, ...)`. ## Types diff --git a/docs/cstr_api.md b/docs/cstr_api.md index 47c4716c..80d8543a 100644 --- a/docs/cstr_api.md +++ b/docs/cstr_api.md @@ -15,9 +15,6 @@ This describes the API of string type **cstr_t**. | Name | Value | |:---------------------------|:-----------------| | `cstr_npos` | `-1ull` | -| `cstr_size(str) | | -| `cstr_capacity(str) | | -| `cstr_empty(str) | | ## Header file 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); |