summaryrefslogtreecommitdiffhomepage
path: root/docs/cstack_api.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cstack_api.md')
-rw-r--r--docs/cstack_api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index b971811c..68f22b57 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -8,13 +8,13 @@ See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack
## Header file and declaration
```c
-#define i_tag
-#define i_val // required
-#define i_cmp // required if i_val is a struct
-#define i_valdel
-#define i_valfrom
-#define i_valto
-#define i_valraw
+#define i_tag // defaults to i_val name
+#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_valraw // convertion "raw" type - defaults to i_val
+#define i_valfrom // convertion func i_valraw => i_val - defaults to plain copy
+#define i_valto // convertion func i_val* => i_valraw - defaults to plain copy
+#define i_valdel // destroy value func - defaults to empty destruct
#include <stc/cstack.h>
```
`X` should be replaced by the value of i_tag in all of the following documentation.