summaryrefslogtreecommitdiffhomepage
path: root/docs/cbox_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-12-12 22:20:43 +0100
committerTyge Løvset <[email protected]>2021-12-12 22:20:43 +0100
commitc8acb5c9dded30350f294e70b55c33ad177c2049 (patch)
treeb4dfab3ac0754ecd9e89604a6754e21fe1988a30 /docs/cbox_api.md
parent9c6be40eeba170502f1cdd5c3e933b6616ca7c3f (diff)
downloadSTC-modified-c8acb5c9dded30350f294e70b55c33ad177c2049.tar.gz
STC-modified-c8acb5c9dded30350f294e70b55c33ad177c2049.zip
Try fix ptr_elems.c. Some more docs for cbox. Temporarily comment out benchmark Action
Diffstat (limited to 'docs/cbox_api.md')
-rw-r--r--docs/cbox_api.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/cbox_api.md b/docs/cbox_api.md
index 7c632919..1f10928d 100644
--- a/docs/cbox_api.md
+++ b/docs/cbox_api.md
@@ -16,13 +16,17 @@ See similar c++ class [std::unique_ptr](https://en.cppreference.com/w/cpp/memory
## Header file and declaration
```c
-#define i_val // value: REQUIRED
-#define i_cmp // three-way compare two i_val* : REQUIRED IF i_val is a non-integral type
-#define i_del // destroy value func - defaults to empty destruct
-#define i_tag // defaults to i_val
-#include <stc/cbox.h>
+#define i_val // value: REQUIRED
+#define i_cmp // three-way compare two i_val* : REQUIRED IF i_val is a non-integral type
+#define i_del // destroy value func - defaults to empty destruct
+#define i_from // create from raw/clone func - REQUIRED if i_del is defined,
+ // unless 'i_opt c_no_clone' is defined.
+#define i_tag // type name tag, defaults to i_val
+#include <stc/cbox.h>
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.
+Define `i_opt` with `c_no_compare` if comparison between i_val's is not needed/available. Will then
+compare the pointer addresses when used. Additionally, `c_no_clone` or `i_is_fwd` may be defined.
## Methods
```c