summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-09-23 08:13:46 +0200
committerTyge Løvset <[email protected]>2021-09-23 08:13:46 +0200
commit7b5ad58d20dcf3561662a294183fceab0d0ee73c (patch)
tree6a3dec1ac0f65a886c1287c1468bb1bf705d92f0 /docs
parent6b0cee466ec405a8b8051da56fc63ed3e2930846 (diff)
downloadSTC-modified-7b5ad58d20dcf3561662a294183fceab0d0ee73c.tar.gz
STC-modified-7b5ad58d20dcf3561662a294183fceab0d0ee73c.zip
Some more documentation in README.md.
Added support for i_del template arg/define for destroy function. For maps, i_keydel / i_valdel is still required and error is given if i_del is defined.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md3
-rw-r--r--docs/cvec_api.md2
2 files changed, 4 insertions, 1 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 5a86240f..b567d8aa 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -11,7 +11,8 @@ See the c++ class [boost::multi_array](https://www.boost.org/doc/libs/release/li
```c
#define i_tag // defaults to i_val name
#define i_val // value: REQUIRED
-#define i_valfrom // clone func i_val => i_val - defaults to plain copy
+#define i_valfrom // func Raw => i_val - defaults to plain copy
+#define i_valto // func i_val => Raw - defaults to plain copy
#define i_valdel // destroy value func - defaults to empty destruct
#include <stc/carr2.h> // or <stc/carr3.h>
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 294d3a59..3b1ff265 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -23,6 +23,8 @@ 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_del` may be defined instead of `i_valdel` (or `i_keydel`) for all non-map containers.
+
## Methods
```c