diff options
| author | Tyge Lovset <[email protected]> | 2022-08-11 22:34:16 +0200 |
|---|---|---|
| committer | Tyge Lovset <[email protected]> | 2022-08-11 22:34:16 +0200 |
| commit | 2526ae23267a5381f0564100b2aba73dfc367b58 (patch) | |
| tree | 4da8bd5c1009dfc8871572d2985d07b073ee71dd | |
| parent | 3c110651771642cf28d6998e101a197b0cb02a4b (diff) | |
| download | STC-modified-2526ae23267a5381f0564100b2aba73dfc367b58.tar.gz STC-modified-2526ae23267a5381f0564100b2aba73dfc367b58.zip | |
Update cbox/carc docs.
| -rw-r--r-- | docs/carc_api.md | 14 | ||||
| -rw-r--r-- | docs/cbox_api.md | 15 |
2 files changed, 21 insertions, 8 deletions
diff --git a/docs/carc_api.md b/docs/carc_api.md index 243349a8..8061c642 100644 --- a/docs/carc_api.md +++ b/docs/carc_api.md @@ -47,10 +47,16 @@ long carc_X_use_count(carc_X ptr); void carc_X_reset(carc_X* self); void carc_X_reset_to(carc_X* self, i_val* p); // assign new carc from ptr. Takes ownership of p. -uint64_t carc_X_value_hash(const i_val* x); // hash value -int carc_X_value_cmp(const i_val* x, const i_val* y); // compares pointer addresses if 'i_opt c_no_cmp' - // is defined. Otherwise uses 'i_cmp' or default compare. -bool carc_X_value_eq(const i_val* x, const i_val* y); // carc_X_value_cmp == 0 +uint64_t carc_X_hash(const carc_X* x); // hash value +int carc_X_cmp(const carc_X* x, const carc_X* y); // compares pointer addresses if 'i_opt c_no_cmp' + // is defined. Otherwise uses 'i_cmp' or default cmp. +bool carc_X_eq(const carc_X* x, const carc_X* y); // carc_X_cmp() == 0 + +// functions on pointed to objects. + +uint64_t carc_X_value_hash(const i_val* x); +int carc_X_value_cmp(const i_val* x, const i_val* y); +bool carc_X_value_eq(const i_val* x, const i_val* y); ``` ## Types and constants diff --git a/docs/cbox_api.md b/docs/cbox_api.md index 9801ad92..2587fdf8 100644 --- a/docs/cbox_api.md +++ b/docs/cbox_api.md @@ -44,11 +44,18 @@ void cbox_X_drop(cbox_X* self); // destruct the co void cbox_X_reset(cbox_X* self); void cbox_X_reset_to(cbox_X* self, i_val* p); // assign new cbox from ptr. Takes ownership of p. -uint64_t cbox_X_value_hash(const i_val* p); // hash value -int cbox_X_value_cmp(const i_val* p, const i_val* y); // compares pointer addresses if 'i_opt c_no_cmp' - // is defined. Otherwise uses 'i_cmp' or default compare. -bool cbox_X_value_eq(const i_val* p, const i_val* y); // cbox_X_value_cmp == 0 +uint64_t cbox_X_hash(const cbox_X* x); // hash value +int cbox_X_cmp(const cbox_X* x, const cbox_X* y); // compares pointer addresses if 'i_opt c_no_cmp' + // is defined. Otherwise uses 'i_cmp' or default cmp. +bool cbox_X_eq(const cbox_X* x, const cbox_X* y); // cbox_X_cmp() == 0 + +// functions on pointed to objects. + +uint64_t cbox_X_value_hash(const i_val* x); +int cbox_X_value_cmp(const i_val* x, const i_val* y); +bool cbox_X_value_eq(const i_val* x, const i_val* y); ``` + ## Types and constants | Type name | Type definition | Used to represent... | |
