summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-20 13:09:42 +0100
committerGitHub <[email protected]>2021-01-20 13:09:42 +0100
commit58fcd34c60910888b008202c1e26dc98a9ceca31 (patch)
treeea5092b06231399f7ac391ce099db4963d56a0d5 /docs
parent03303cddb4181b5679b17002d1dbf619d64a556f (diff)
downloadSTC-modified-58fcd34c60910888b008202c1e26dc98a9ceca31.tar.gz
STC-modified-58fcd34c60910888b008202c1e26dc98a9ceca31.zip
Update csmap_api.md
Diffstat (limited to 'docs')
-rw-r--r--docs/csmap_api.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index db876ad6..3060811e 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -33,7 +33,7 @@ be replaced by `my` in all of the following documentation.
`using_csmap_strkey()` and `using_csmap_strval()` are special macros defined by
`using_csmap()`. The macro `using_csmap_str()` is a shorthand for
```c
-using_csmap(str, cstr_t, cstr_t, cstr_compare_raw, cstr_del, cstr_from, ...)
+using_csmap(str, cstr, cstr, cstr_compare_raw, cstr_del, cstr_from, ...)
```
## Header file
@@ -57,17 +57,17 @@ size_t csmap_X_size(csmap_X m);
void csmap_X_push_n(csmap_X* self, const csmap_X_rawvalue_t arr[], size_t size);
-csmap_X_result_t csmap_X_emplace(csmap_X* self, RawKey rkey, RawMapped rmapped); // no change if rkey in map
-csmap_X_result_t csmap_X_insert(csmap_X* self, csmap_X_rawvalue_t rval); // same
+csmap_X_result_t csmap_X_emplace(csmap_X* self, RawKey rkey, RawMapped rmapped); // no change if rkey in map
+csmap_X_result_t csmap_X_insert(csmap_X* self, csmap_X_rawvalue_t rval); // same, just different param
csmap_X_result_t csmap_X_insert_or_assign(csmap_X* self, RawKey rkey, RawMapped rmapped);
-csmap_X_result_t csmap_X_put(csmap_X* self, RawKey rkey, RawMapped rmapped); // same as insert_or_assign()
-csmap_X_result_t csmap_X_put_mapped(csmap_X* self, RawKey rkey, Mapped mapped); // same
-csmap_X_mapped_t* csmap_X_at(const csmap_X* self, RawKey rkey); // rkey must be in map.
+csmap_X_result_t csmap_X_put(csmap_X* self, RawKey rkey, RawMapped rmapped); // same as insert_or_assign()
+csmap_X_result_t csmap_X_put_mapped(csmap_X* self, RawKey rkey, Mapped mapped); // same, different param
+csmap_X_mapped_t* csmap_X_at(const csmap_X* self, RawKey rkey); // rkey must be in map.
size_t csmap_X_erase(csmap_X* self, RawKey rkey);
csmap_X_iter_t csmap_X_erase_at(csmap_X* self, csmap_X_iter_t pos);
-csmap_X_value_t* csmap_X_find(const csmap_X* self, RawKey rkey); // NULL if not found
+csmap_X_value_t* csmap_X_find(const csmap_X* self, RawKey rkey); // NULL if not found
csmap_X_value_t* csmap_X_find_it(const csmap_X* self, RawKey rkey, csmap_X_iter_t* out);
bool csmap_X_contains(const csmap_X* self, RawKey rkey);