summaryrefslogtreecommitdiffhomepage
path: root/docs/cqueue_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/cqueue_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/cqueue_api.md')
-rw-r--r--docs/cqueue_api.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index a8be9e86..89ca7d5c 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -7,14 +7,16 @@ See the c++ class [std::queue](https://en.cppreference.com/w/cpp/container/queue
## Header file and declaration
```c
+#define i_type // container type name (default: cset_{i_key})
#define i_val // value: REQUIRED
-#define i_cmp // three-way compare two i_valraw* : REQUIRED IF i_valraw is a non-integral type
#define i_valdrop // destroy value func - defaults to empty destruct
#define i_valclone // REQUIRED IF i_valdrop defined
+
#define i_valraw // convertion "raw" type - defaults to i_val
#define i_valfrom // convertion func i_valraw => i_val
#define i_valto // convertion func i_val* => i_valraw
-#define i_tag // defaults to i_val
+
+#define i_tag // alternative typename: cqueue_{i_tag}. i_tag defaults to i_val
#include <stc/cqueue.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.