diff options
| author | Tyge Løvset <[email protected]> | 2021-02-22 20:00:13 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-02-22 20:00:13 +0100 |
| commit | af03e9fd5055373c3bbad2af58cb5ffc2db53fd9 (patch) | |
| tree | ca1f4827122b5890df75e99708ed39b93ed1663b /docs/cptr_api.md | |
| parent | 36872c10c9041c0a46b3d205ca04380cb55ab283 (diff) | |
| download | STC-modified-af03e9fd5055373c3bbad2af58cb5ffc2db53fd9.tar.gz STC-modified-af03e9fd5055373c3bbad2af58cb5ffc2db53fd9.zip | |
Added destructor comment and value_clone docs.
Diffstat (limited to 'docs/cptr_api.md')
| -rw-r--r-- | docs/cptr_api.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/cptr_api.md b/docs/cptr_api.md index 678dfb6b..66c5797b 100644 --- a/docs/cptr_api.md +++ b/docs/cptr_api.md @@ -38,7 +38,7 @@ The *del()* and *compare()* methods are defined based on the arguments passed to cptr_X cptr_X_init(void); cptr_X cptr_X_clone(cptr_X ptr); void cptr_X_reset(cptr_X* self, cptr_X_value_t* ptr); -void cptr_X_del(cptr_X* self); +void cptr_X_del(cptr_X* self); // destructor int cptr_X_compare(cptr_X* x, cptr_X* y); ``` ### Shared pointer @@ -46,8 +46,8 @@ int cptr_X_compare(cptr_X* x, cptr_X* y); csptr_X csptr_X_from(csptr_X_value_t* ptr); csptr_X csptr_X_make(csptr_X_value_t val); void csptr_X_reset(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_del(csptr_X* self); // decrease use count, destroy if 0 +csptr_X csptr_X_clone(csptr_X sptr); // share the pointer (increase use count) +void csptr_X_del(csptr_X* self); // destructor: decrease use count, destroy if 0 int csptr_X_compare(csptr_X* x, csptr_X* y); ``` |
