summaryrefslogtreecommitdiffhomepage
path: root/docs/csset_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-11-06 12:57:47 +0100
committerTyge Løvset <[email protected]>2022-11-06 12:57:47 +0100
commitb69006463de7b3f11d974bdddb5782282482f515 (patch)
tree6f182dc201164fead2b5b1a094e6e8a2b43dc0a1 /docs/csset_api.md
parentc230e4cd830de22fad2f7085d968d905dadc7418 (diff)
downloadSTC-modified-b69006463de7b3f11d974bdddb5782282482f515.tar.gz
STC-modified-b69006463de7b3f11d974bdddb5782282482f515.zip
Improved documentation of template parameters for all containers.
Diffstat (limited to 'docs/csset_api.md')
-rw-r--r--docs/csset_api.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 82b8eb09..6b2bdfdf 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -8,14 +8,18 @@ See the c++ class [std::set](https://en.cppreference.com/w/cpp/container/set) fo
## Header file and declaration
```c
+#define i_type // full typename of the container
#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_keydrop // destroy key func - defaults to empty destruct
+#define i_keyclone // REQUIRED IF i_keydrop defined
+
#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 // typename tag. defaults to i_key
-#define i_type // full typename of the container
+
+#define i_cmp_functor // advanced, see examples/cpque.c for similar usage.
+#define i_tag // alternative typename: csset_{i_tag}. i_tag defaults to i_val
#include <stc/csset.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.