diff options
| author | Tyge Løvset <[email protected]> | 2021-12-29 15:42:10 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-12-29 15:42:10 +0100 |
| commit | 15e1dd79211828bcb8c2a809837b56397d65c6d9 (patch) | |
| tree | 77f7ae49c26ccc514dd80836223ae032a18c79e6 /docs/cset_api.md | |
| parent | a53b2f4269951e0b5340723670137b4fdf96534c (diff) | |
| download | STC-modified-15e1dd79211828bcb8c2a809837b56397d65c6d9.tar.gz STC-modified-15e1dd79211828bcb8c2a809837b56397d65c6d9.zip | |
Fixed minors in map docs.
Diffstat (limited to 'docs/cset_api.md')
| -rw-r--r-- | docs/cset_api.md | 8 |
1 files changed, 4 insertions, 4 deletions
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 <stc/cset.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.
|
