diff options
| author | Tyge Løvset <[email protected]> | 2021-10-05 09:00:28 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-10-05 09:05:25 +0200 |
| commit | bf00ed0e7023cf49cf004dd4b4b39af2b824681e (patch) | |
| tree | adadcc1ac34fd5b614e566028d37d29db8fb7f80 /docs/cvec_api.md | |
| parent | 88c67afa63e46551c67f573e0557323518c42f81 (diff) | |
| download | STC-modified-bf00ed0e7023cf49cf004dd4b4b39af2b824681e.tar.gz STC-modified-bf00ed0e7023cf49cf004dd4b4b39af2b824681e.zip | |
Changed recommended order of defining template parameters.
Diffstat (limited to 'docs/cvec_api.md')
| -rw-r--r-- | docs/cvec_api.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md index ee02950f..549bce2a 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -12,13 +12,13 @@ See the c++ class [std::vector](https://en.cppreference.com/w/cpp/container/vect ## Header file and declaration ```c -#define i_tag // defaults to i_val name #define i_val // value: REQUIRED #define i_cmp // three-way compare two i_valraw* : REQUIRED IF i_valraw is a non-integral type +#define i_del // destroy value func - defaults to empty destruct #define i_valraw // convertion "raw" type - defaults to i_val #define i_valfrom // convertion func i_valraw => i_val - defaults to plain copy #define i_valto // convertion func i_val* => i_valraw - defaults to plain copy -#define i_valdel // destroy value func - defaults to empty destruct +#define i_tag // defaults to i_val #include <stc/cvec.h> ``` `X` should be replaced by the value of `i_tag` in all of the following documentation. @@ -99,9 +99,10 @@ cvec_X_value_t cvec_X_value_clone(cvec_X_value_t val); ## Examples ```c -#define i_tag i #define i_val int +#define i_tag i #include <stc/cvec.h> + #include <stdio.h> int main() @@ -192,12 +193,13 @@ User User_clone(User user) { return user; } -// declare a memory managed, clonable vector of users: -#define i_tag u +// Declare a memory managed, clonable vector of users. +// Note that cvec_u_emplace_back() will clone input: #define i_val User #define i_cmp User_compare -#define i_valdel User_del +#define i_del User_del #define i_valfrom User_clone +#define i_tag u #include <stc/cvec.h> int main(void) { |
