summaryrefslogtreecommitdiffhomepage
path: root/docs/carc_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-10-24 12:23:30 +0200
committerTyge Løvset <[email protected]>2022-10-24 12:23:30 +0200
commitcf2ff10878153588b69e7e34523773e2bc42d79e (patch)
tree8980db94a0c79f5b02489510159821c0b8f22a39 /docs/carc_api.md
parent60611de13ad64442287c5a57c7aa874ad45273ab (diff)
downloadSTC-modified-cf2ff10878153588b69e7e34523773e2bc42d79e.tar.gz
STC-modified-cf2ff10878153588b69e7e34523773e2bc42d79e.zip
API CHANGE: Renamed input params for naming consisteny and usage:
i_key_class TYPE => i_keyclass TYPE i_val_class TYPE => i_valclass TYPE i_key_arcbox TYPE => i_keyboxed TYPE i_val_arcbox TYPE => i_valboxed TYPE i_key_bind, i_val_bind are removed.
Diffstat (limited to 'docs/carc_api.md')
-rw-r--r--docs/carc_api.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/carc_api.md b/docs/carc_api.md
index 4dea2b2c..04856622 100644
--- a/docs/carc_api.md
+++ b/docs/carc_api.md
@@ -13,7 +13,7 @@ All **carc** functions can be called by multiple threads on different instances
additional synchronization even if these instances are copies and share ownership of the same object.
**carc** uses thread-safe atomic reference counting, through the *carc_X_clone()* and *carc_X_drop()* methods.
-When declaring a container with shared pointers, define `i_val_arcbox` with the carc type, see example.
+When declaring a container with shared pointers, define `i_valboxed` with the carc type, see example.
See similar c++ class [std::shared_ptr](https://en.cppreference.com/w/cpp/memory/shared_ptr) for a functional reference, or Rust [std::sync::Arc](https://doc.rust-lang.org/std/sync/struct.Arc.html) / [std::rc::Rc](https://doc.rust-lang.org/std/rc/struct.Rc.html).
@@ -89,7 +89,7 @@ bool carc_X_value_eq(const i_val* x, const i_val* y);
#include <stc/carc.h>
#define i_type Stack
-#define i_val_arcbox Arc // Note: use i_val_arcbox for carc or cbox value types
+#define i_valboxed Arc // Note: use i_valboxed for carc or cbox value types
#include <stc/cstack.h>
int main()