diff options
| author | Tyge Løvset <[email protected]> | 2021-02-21 23:47:56 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-02-21 23:47:56 +0100 |
| commit | 73632edaa63b83b1f25bbcc41b5e0e8acf500ad2 (patch) | |
| tree | 97ae05e545c8ac7c89ad53e804fe14567f7b7435 /docs/cvec_api.md | |
| parent | b4fe781e2caeed3f0dec670def76df9bf4cefc95 (diff) | |
| download | STC-modified-73632edaa63b83b1f25bbcc41b5e0e8acf500ad2.tar.gz STC-modified-73632edaa63b83b1f25bbcc41b5e0e8acf500ad2.zip | |
Updates outdated docs.
Diffstat (limited to 'docs/cvec_api.md')
| -rw-r--r-- | docs/cvec_api.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md index f79ad3b0..b6aa841f 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -19,8 +19,7 @@ using_cvec(X, Value, valueCompareRaw, valueDestroy, valueFromRaw, valueToRaw, Ra using_cvec_str() ``` -The macro `using_cvec()` can be instantiated with 2, 3, 5, or 7 arguments in the global scope. -Defaults values are given above for args not specified. `X` is a type tag name and +The macro `using_cvec()` must be instantiated in the global scope. `X` is a type tag name and will affect the names of all cvec types and methods. E.g. declaring `using_cvec(my, int);`, `X` should be replaced by `my` in all of the following documentation. @@ -82,8 +81,8 @@ cvec_X_iter_t cvec_X_erase_range_p(cvec_X* self, cvec_X_value_t* pfirst, c cvec_X_iter_t cvec_X_find(const cvec_X* self, RawValue raw); cvec_X_iter_t cvec_X_find_in_range(cvec_X_iter_t i1, cvec_X_iter_t i2, RawValue raw); -bool cvec_X_bsearch(const cvec_X* self, RawValue raw); -bool cvec_X_bsearch_in_range(cvec_X_iter_t i1, cvec_X_iter_t i2, RawValue raw); +cvec_X_iter_t cvec_X_bsearch(const cvec_X* self, RawValue raw); +cvec_X_iter_t cvec_X_bsearch_in_range(cvec_X_iter_t i1, cvec_X_iter_t i2, RawValue raw); void cvec_X_sort(cvec_X* self); void cvec_X_sort_range(cvec_X_iter_t i1, cvec_X_iter_t i2, int(*cmp)(const cvec_X_value_t*, const cvec_X_value_t*)); |
