summaryrefslogtreecommitdiffhomepage
path: root/docs/cptr_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-03 23:04:33 +0100
committerGitHub <[email protected]>2021-01-03 23:04:33 +0100
commit815dfc3e12f127d3c55438b0f784aa515e3812a5 (patch)
treea20df39316b9cbd60613d468c3a6e8642f14fc1b /docs/cptr_api.md
parent49305314eedf1bfddd479f70333b81b74a9bfb0f (diff)
downloadSTC-modified-815dfc3e12f127d3c55438b0f784aa515e3812a5.tar.gz
STC-modified-815dfc3e12f127d3c55438b0f784aa515e3812a5.zip
Update cptr_api.md
Diffstat (limited to 'docs/cptr_api.md')
-rw-r--r--docs/cptr_api.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 7cc7aa88..1fa344ae 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -14,12 +14,12 @@ Raw pointers and shared pointers (**csptr**) may be used as items of containers.
#define using_csptr(X, Value, valueCompare=c_default_compare,
valueDestroy=c_default_del,
- valueClone=c_default_clone)
+ valueClone=ignored)
```
The macro `using_cptr()` must be instantiated in the global scope. `X` is a type tag name and will
affect the names of all cptr types and methods. E.g. declaring `using_cptr(my, cvec_my);`,
`X` should be replaced by `my` in all of the following documentation.
-Note that if valueDestroy is specified and not *valueClone*, it expects *Value_clone* to be defined
+Note: for shared-ptr csptr, "cloning" is done by pointer sharing (ref counting), so valueClone is not required and ignored.
Types