summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cmap_api.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 4a696ab7..6e1b7af4 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -18,11 +18,12 @@ See [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_m
RawKey=Key)
// or:
#define using_cmap(X, Key, Mapped, mappedDestroy,
- mappedFromRaw, keyFromRaw, RawMapped,
+ mappedFromRaw, mappedToRaw, RawMapped,
keyEqualsRaw, keyHashRaw, keyDestroy,
keyFromRaw, keyToRaw, RawKey)
-
-#define using_cmap_strkey(X, Mapped, mappedDestroy=c_default_del)
+
+#define using_cmap_strkey(X, Mapped, mappedDestroy=c_default_del,
+ mappedClone=c_default_clone)
#define using_cmap_strval(X, Key, keyEquals=c_default_equals,
keyHash=c_default_hash,
@@ -32,7 +33,7 @@ See [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_m
RawKey=Key)
#define using_cmap_str()
```
-The macro `using_cmap()` can be instantiated with 3, 4, 6, 10, or 12 arguments in the global scope.
+The macro `using_cmap()` can be instantiated with 3, 4, 5, 7, 9, 11, or 13 arguments in the global scope.
Default values are given above for args not specified. `X` is a type tag name and
will affect the names of all cmap types and methods. E.g. declaring `using_cmap(my, int);`, `X` should
be replaced by `my` in all of the following documentation.
@@ -42,8 +43,10 @@ be replaced by `my` in all of the following documentation.
`using_cmap_strkey()` and `using_cmap_strval()` are special macros defined by
`using_cmap()`. The macro `using_cmap_str()` is a shorthand for
```c
-using_cmap(str, cstr_t, cstr_t, cstr_del, cstr_equals_raw, cstr_hash_raw,
- cstr_del, const char*, cstr_from, cstr_to_raw, const char*, cstr_from)
+using_cmap(str, cstr_t, cstr_t, cstr_del,
+ cstr_from, cstr_to_raw, const char*,
+ cstr_equals_raw, cstr_hash_raw, cstr_del,
+ cstr_from, cstr_to_raw, const char*)
```
## Types