diff options
| author | Tyge Løvset <[email protected]> | 2021-04-15 15:15:02 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-04-15 15:15:02 +0200 |
| commit | 6b55c6fee03d6a1d846eb1b05e810f1841ac7ae2 (patch) | |
| tree | c9b6c13d01f41a91ac8dc7301953f433cc1ba2d7 /docs/csptr_api.md | |
| parent | 673b1911f8d3d74199ec9d5144fb4540b1b5ebc3 (diff) | |
| download | STC-modified-6b55c6fee03d6a1d846eb1b05e810f1841ac7ae2.tar.gz STC-modified-6b55c6fee03d6a1d846eb1b05e810f1841ac7ae2.zip | |
NB! Changed API: *_erase_at(container, it) --> *_erase_it(container, it). cvec and cdeq insert_at() swapped with insert(). Docs update.
Diffstat (limited to 'docs/csptr_api.md')
| -rw-r--r-- | docs/csptr_api.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/csptr_api.md b/docs/csptr_api.md index 9669d97b..e1670bb2 100644 --- a/docs/csptr_api.md +++ b/docs/csptr_api.md @@ -39,7 +39,7 @@ The *csptr_X_compare()*, *csptr_X_equals()* and *csptr_X_del()* methods are defi csptr_X csptr_X_from(csptr_X_value_t* ptr); // constructor csptr_X csptr_X_make(csptr_X_value_t val); // make_shared void csptr_X_reset(csptr_X* self); -void csptr_X_reset_to(csptr_X* self, csptr_X_value_t* ptr); +void csptr_X_reset_with(csptr_X* self, csptr_X_value_t* ptr); csptr_X csptr_X_clone(csptr_X sptr); // share the pointer (increase use count) void csptr_X_move(csptr_X* self); // transfer ownership instead of sharing. @@ -49,10 +49,11 @@ int csptr_X_compare(csptr_X* x, csptr_X* y); bool csptr_X_equals(csptr_X* x, csptr_X* y); ``` -## Types +## Types and constants | Type name | Type definition | Used to represent... | |:--------------------|:--------------------------------------------------------------|:-------------------------| +| `csptr_null` | `{NULL, NULL}` | Init nullptr const | | `csptr_X` | `struct { csptr_X_value_t* get; atomic_count_t* use_count; }` | The csptr type | | `csptr_X_value_t` | `Value` | The csptr element type | | `atomic_count_t` | `long` | The reference counter | |