diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/carc_api.md | 2 | ||||
| -rw-r--r-- | docs/cbox_api.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/carc_api.md b/docs/carc_api.md index cc5b3f41..90aec0ed 100644 --- a/docs/carc_api.md +++ b/docs/carc_api.md @@ -32,7 +32,7 @@ See similar c++ class [std::shared_ptr](https://en.cppreference.com/w/cpp/memory ## Methods ```c carc_X carc_X_init(); // empty shared pointer -carc_X carc_X_make(i_valraw raw); // construct owned value from raw type +carc_X carc_X_make(i_valraw raw); // create owned value from raw type, if defined. carc_X carc_X_from(i_val val); // create new heap allocated object. Take ownership of val. carc_X carc_X_from_ptr(i_val* p); // create a carc from raw pointer. Takes ownership of p. diff --git a/docs/cbox_api.md b/docs/cbox_api.md index 556c56df..a4e88801 100644 --- a/docs/cbox_api.md +++ b/docs/cbox_api.md @@ -31,7 +31,7 @@ compare the pointer addresses when used. Additionally, `c_no_clone` or `i_is_fwd ## Methods ```c cbox_X cbox_X_init(); // return an empty cbox -cbox_X cbox_X_make(i_valraw raw); // create owned value from raw type. +cbox_X cbox_X_make(i_valraw raw); // create owned value from raw type, if defined. cbox_X cbox_X_from(i_val val); // allocate new heap object with val. Take ownership of val. cbox_X cbox_X_from_ptr(i_val* p); // create a cbox from a pointer. Takes ownership of p. |