diff options
| author | Tyge Løvset <[email protected]> | 2020-12-01 15:04:54 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-12-01 15:04:54 +0100 |
| commit | 65033a7da71abb322b3dacf3e4a160961972c39e (patch) | |
| tree | fa98d497a6925164a90aafc38bfed956734809da /docs/cmap_api.md | |
| parent | 15c2c8615a28427f0e52907496139f00d9d2b8e7 (diff) | |
| download | STC-modified-65033a7da71abb322b3dacf3e4a160961972c39e.tar.gz STC-modified-65033a7da71abb322b3dacf3e4a160961972c39e.zip | |
Some cmap docs improvement.
Diffstat (limited to 'docs/cmap_api.md')
| -rw-r--r-- | docs/cmap_api.md | 5 |
1 files changed, 3 insertions, 2 deletions
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 |