summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-10 23:07:03 +0100
committerTyge Løvset <[email protected]>2020-12-10 23:07:03 +0100
commit95f9cb433cb65749af3f489563dc18a2a9fa00cc (patch)
tree4ed5c5831f1495bb1e45f7b85947b983f0d98161 /docs/cmap_api.md
parent8e1e7c94f5195d5e15260c4a05ab479fec2222a2 (diff)
downloadSTC-modified-95f9cb433cb65749af3f489563dc18a2a9fa00cc.tar.gz
STC-modified-95f9cb433cb65749af3f489563dc18a2a9fa00cc.zip
Reverted cuptr to cptr. Added some typedefs in docs in cmap and cset.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index f3046648..9cd40555 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -41,17 +41,17 @@ using_cmap(str, cstr_t, cstr_t, cstr_del, cstr_equals_raw, cstr_hash_raw,
## Types
-| Type name | Type definition | Used to represent... |
-|:---------------------|:-----------------------|:------------------------------|
-| `cmap_X` | `struct { ... }` | The cmap type |
-| `cmap_X_rawkey_t` | `RawKey` | The raw key type |
-| `cmap_X_rawval_t` | `RawMapped` | The raw mapped type |
-| `cmap_X_key_t` | `Key` | The key type |
-| `cmap_X_mapped_t` | `Mapped` | The mapped type |
-| `cmap_X_value_t` | `struct { ... }` | The value type |
-| `cmap_X_input_t` | `struct { ... }` | RawKey + RawVal type |
-| `cmap_X_result_t` | `struct { ... }` | Result of insert/put/emplace |
-| `cmap_X_iter_t` | `struct { ... }` | Iterator type |
+| Type name | Type definition | Used to represent... |
+|:---------------------|:------------------------------------------------|:------------------------------|
+| `cmap_X` | `struct { ... }` | The cmap type |
+| `cmap_X_rawkey_t` | `RawKey` | The raw key type |
+| `cmap_X_rawval_t` | `RawMapped` | The raw mapped type |
+| `cmap_X_key_t` | `Key` | The key type |
+| `cmap_X_mapped_t` | `Mapped` | The mapped type |
+| `cmap_X_value_t` | `struct { Key first; Mapped second; }` | The value type |
+| `cmap_X_input_t` | `struct { RawKey first; RawMapped second; }` | RawKey + RawVal type |
+| `cmap_X_result_t` | `struct { cmap_X_value_t first; bool second; }` | Result of insert/put/emplace |
+| `cmap_X_iter_t` | `struct { cmap_X_value_t *val; ... }` | Iterator type |
## Constants and macros