summaryrefslogtreecommitdiffhomepage
path: root/docs/cvec_api.md
diff options
context:
space:
mode:
authorTyge Lovset <[email protected]>2022-04-18 12:12:01 +0200
committerTyge Lovset <[email protected]>2022-04-18 12:12:01 +0200
commitb0d60c33a073782fe0bb08c835ca9db0b94145d0 (patch)
tree1683369ec66467720502b3d904bf9ab11343076e /docs/cvec_api.md
parent00804d9ff488f63468a0bb528c7b807aea7c3ea3 (diff)
downloadSTC-modified-b0d60c33a073782fe0bb08c835ca9db0b94145d0.tar.gz
STC-modified-b0d60c33a073782fe0bb08c835ca9db0b94145d0.zip
Removed i_drop and i_from template specifiers to reduce redundancies and add clarity (error given if used): use i_valdrop/i_valfrom and i_keydrop/i_keyfrom instead.
Added missing at_mut() function to cdeq.
Diffstat (limited to 'docs/cvec_api.md')
-rw-r--r--docs/cvec_api.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 660f7a67..e02a944e 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -14,7 +14,7 @@ See the c++ class [std::vector](https://en.cppreference.com/w/cpp/container/vect
```c
#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_drop // destroy value func - defaults to empty destruct
+#define i_valdrop // destroy value func - defaults to empty destruct
#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
@@ -23,7 +23,7 @@ See the c++ class [std::vector](https://en.cppreference.com/w/cpp/container/vect
```
`X` should be replaced by the value of `i_tag` in all of the following documentation.
-`i_drop` may be defined instead of `i_valdrop` (or `i_keydrop`) for all non-map containers.
+`i_valdrop` may be defined instead of `i_valdrop` (or `i_keydrop`) for all non-map containers.
## Methods
@@ -202,8 +202,8 @@ User User_clone(User user) {
// Note that cvec_u_emplace_back() will clone input:
#define i_val User
#define i_cmp User_cmp
-#define i_drop User_drop
-#define i_from User_clone
+#define i_valdrop User_drop
+#define i_valfrom User_clone
#define i_tag u
#include <stc/cvec.h>