From 7b5ad58d20dcf3561662a294183fceab0d0ee73c Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Thu, 23 Sep 2021 08:13:46 +0200 Subject: 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. --- docs/carray_api.md | 3 ++- docs/cvec_api.md | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) (limited to 'docs') 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 // or 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 -- cgit v1.2.3