summaryrefslogtreecommitdiffhomepage
path: root/docs/cset_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-10-05 09:00:28 +0200
committerTyge Løvset <[email protected]>2021-10-05 09:05:25 +0200
commitbf00ed0e7023cf49cf004dd4b4b39af2b824681e (patch)
treeadadcc1ac34fd5b614e566028d37d29db8fb7f80 /docs/cset_api.md
parent88c67afa63e46551c67f573e0557323518c42f81 (diff)
downloadSTC-modified-bf00ed0e7023cf49cf004dd4b4b39af2b824681e.tar.gz
STC-modified-bf00ed0e7023cf49cf004dd4b4b39af2b824681e.zip
Changed recommended order of defining template parameters.
Diffstat (limited to 'docs/cset_api.md')
-rw-r--r--docs/cset_api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cset_api.md b/docs/cset_api.md
index d6c4ab80..e09436ea 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_tag // defaults to i_key name
#define i_key // key: REQUIRED
#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type
-#define i_equ // equality comparison two i_keyraw*. REQUIRED IF i_keyraw is a non-integral type
-#define i_cmp // three-way compare two i_keyraw* : alternative to i_equ
+#define i_cmp // three-way compare two i_keyraw*: REQUIRED IF i_keyraw is a non-integral type
+#define i_equ // equality comparison two i_keyraw*: ALTERNATIVE to i_cmp
+#define i_del // 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_keydel // destroy key func - defaults to empty destruct
+#define i_tag // defaults to i_key
#include <stc/cset.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.