diff options
| author | Tyge Løvset <[email protected]> | 2022-05-02 00:02:13 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2022-05-02 00:02:13 +0200 |
| commit | ed1af86a761ab0f68ee960905b5886cdc62f4e7f (patch) | |
| tree | f6ec758afe3ba12e5829c147c30ab86625890329 /docs | |
| parent | 96e9ed4ae8e191f071c40fce11f3899fc0fb5db3 (diff) | |
| download | STC-modified-ed1af86a761ab0f68ee960905b5886cdc62f4e7f.tar.gz STC-modified-ed1af86a761ab0f68ee960905b5886cdc62f4e7f.zip | |
A few more docs bugs fixed.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cbox_api.md | 2 | ||||
| -rw-r--r-- | docs/cset_api.md | 2 | ||||
| -rw-r--r-- | docs/csset_api.md | 2 | ||||
| -rw-r--r-- | docs/cvec_api.md | 2 |
4 files changed, 3 insertions, 5 deletions
diff --git a/docs/cbox_api.md b/docs/cbox_api.md index 02b827a3..2b91a137 100644 --- a/docs/cbox_api.md +++ b/docs/cbox_api.md @@ -1,6 +1,6 @@ # STC [cbox](../include/stc/cbox.h): Smart Pointer (Boxed object) -**cbox** is a A box is a smart pointer to a heap allocated value of type X. A **cbox** can +**cbox** is a smart pointer to a heap allocated value of type X. A **cbox** can be empty. The *cbox_X_cmp()*, *cbox_X_drop()* methods are defined based on the `i_cmp` and `i_valdrop` macros specified. Use *cbox_X_clone(p)* to make a deep copy, which uses the `i_valfrom` macro if defined. diff --git a/docs/cset_api.md b/docs/cset_api.md index a5067b3b..1e361799 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -10,7 +10,7 @@ A **cset** is an associative container that contains a set of unique objects of #define i_key // hash key: REQUIRED.
#define i_hash // hash func: REQUIRED IF i_keyraw is a non-pod type.
#define i_eq // equality comparison two i_keyraw*: !i_cmp will be used if not defined.
-#define i_valdrop // destroy key func - defaults to empty destruct
+#define i_keydrop // destroy key func - defaults to empty destruct
#define i_keyraw // convertion "raw" type - defaults to i_key
#define i_keyfrom // convertion func i_keyraw => i_key - defaults to plain copy
#define i_keyto // convertion func i_key* => i_keyraw - defaults to plain copy
diff --git a/docs/csset_api.md b/docs/csset_api.md index 51d87b21..1f252d13 100644 --- a/docs/csset_api.md +++ b/docs/csset_api.md @@ -10,7 +10,7 @@ See the c++ class [std::set](https://en.cppreference.com/w/cpp/container/set) fo ```c
#define i_key // key: REQUIRED
#define i_cmp // three-way compare two i_keyraw* : REQUIRED IF i_keyraw is a non-integral type
-#define i_valdrop // destroy key func - defaults to empty destruct
+#define i_keydrop // destroy key func - defaults to empty destruct
#define i_keyraw // convertion "raw" type - defaults to i_key
#define i_keyfrom // convertion func i_keyraw => i_key - defaults to plain copy
#define i_keyto // convertion func i_key* => i_keyraw - defaults to plain copy
diff --git a/docs/cvec_api.md b/docs/cvec_api.md index a28ad289..7d724680 100644 --- a/docs/cvec_api.md +++ b/docs/cvec_api.md @@ -23,8 +23,6 @@ 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_valdrop` may be defined instead of `i_valdrop` (or `i_keydrop`) for all non-map containers. - ## Methods ```c |