summaryrefslogtreecommitdiffhomepage
path: root/docs/cbox_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-09-02 23:45:11 +0200
committerTyge Løvset <[email protected]>2022-09-02 23:45:11 +0200
commit491a8cba3ee55a1200fc2de8ef3807dd8436f829 (patch)
treef877ef241836ca369561cf62d2db465ef3cbeca0 /docs/cbox_api.md
parenta2a18a52df4fc10ad453eba7cdfbe2d02a026f0b (diff)
downloadSTC-modified-491a8cba3ee55a1200fc2de8ef3807dd8436f829.tar.gz
STC-modified-491a8cba3ee55a1200fc2de8ef3807dd8436f829.zip
Change: carc and cbox defaults to pointer comparison when none of i_cmp, i_less or i_eq is specified. This removes annoying requirement.
Diffstat (limited to 'docs/cbox_api.md')
-rw-r--r--docs/cbox_api.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/cbox_api.md b/docs/cbox_api.md
index dc90fa8e..6686dde5 100644
--- a/docs/cbox_api.md
+++ b/docs/cbox_api.md
@@ -45,7 +45,7 @@ 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_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'
+int cbox_X_cmp(const cbox_X* x, const cbox_X* y); // compares pointer addresses if no `i_cmp` is specified.
// 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