From 15e1dd79211828bcb8c2a809837b56397d65c6d9 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Wed, 29 Dec 2021 15:42:10 +0100 Subject: Fixed minors in map docs. --- docs/cset_api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/cset_api.md') diff --git a/docs/cset_api.md b/docs/cset_api.md index 32488b81..b5f8073b 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -7,15 +7,15 @@ A **cset** is an associative container that contains a set of unique objects of ## Header file and declaration ```c -#define i_key // key: REQUIRED -#define i_cmp // three-way compare two i_keyraw*: REQUIRED IF i_keyraw is a non-integral type -#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type +#define i_key // hash key: REQUIRED. +#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type. #define i_eq // equality comparison two i_keyraw*: !i_cmp will be used if not defined. #define i_drop // destroy key func - defaults to empty destruct #define i_keyraw // convertion "raw" type - defaults to i_key #define i_keyfrom // convertion func i_keyraw => i_key - defaults to plain copy #define i_keyto // convertion func i_key* => i_keyraw - defaults to plain copy -#define i_tag // defaults to i_key +#define i_tag // typename tag. defaults to i_key +#define i_type // full typename of the container #include ``` `X` should be replaced by the value of `i_tag` in all of the following documentation. -- cgit v1.2.3