From 65033a7da71abb322b3dacf3e4a160961972c39e Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Tue, 1 Dec 2020 15:04:54 +0100 Subject: Some cmap docs improvement. --- docs/cmap_api.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 109791f3..9c90dbdb 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -7,7 +7,7 @@ This describes the API of the unordered map type **cmap**. ```c #define using_cmap_str() -#define using_cmap_strkey(Mapped, mappedDestroy=c_default_del) +#define using_cmap_strkey(X, Mapped, mappedDestroy=c_default_del) #define using_cmap_strval(X, Key, keyEquals=c_default_equals, keyHash=c_default_hash16, @@ -31,7 +31,8 @@ Default values are given above for args not specified. `X` is a type tag name an 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. -`using_cmap_str()` is a predefined macro for `using_cmap(str, cstr_t, ...)`. +`using_cmap_str()` is a specific definition of `using_cmap(str, cstr_t, ...)`. `using_cmap_strkey(X, ...)` and `using_cmap_strval(X, ...)` +are special macros for `using_cmap()` with `cstr_t` as key and mapped value correspondingly. ## Types -- cgit v1.2.3