summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Lovset <[email protected]>2023-04-10 08:36:26 +0200
committerTyge Lovset <[email protected]>2023-04-10 08:36:26 +0200
commit54fe61ed1cbe8f68f7fb5bfafca4c5d135afd200 (patch)
treebc614764fd78daaa095f6840ef15c483ec02c07e /docs/cmap_api.md
parent680faa169dfc7e7d4fc7532922bf7103f8cdc279 (diff)
downloadSTC-modified-54fe61ed1cbe8f68f7fb5bfafca4c5d135afd200.tar.gz
STC-modified-54fe61ed1cbe8f68f7fb5bfafca4c5d135afd200.zip
Improved naming consistency: fixed rawkey - keyraw confusion (mostly internal).
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 8749bd09..d2a94ee8 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -102,12 +102,12 @@ bool c_memcmp_eq(const i_keyraw* a, const i_keyraw* b); // !
| Type name | Type definition | Used to represent... |
|:-------------------|:------------------------------------------------|:------------------------------|
| `cmap_X` | `struct { ... }` | The cmap type |
-| `cmap_X_rawkey` | `i_keyraw` | The raw key type |
-| `cmap_X_rawmapped` | `i_valraw` | The raw mapped type |
-| `cmap_X_raw` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw + i_valraw type |
| `cmap_X_key` | `i_key` | The key type |
| `cmap_X_mapped` | `i_val` | The mapped type |
| `cmap_X_value` | `struct { const i_key first; i_val second; }` | The value: key is immutable |
+| `cmap_X_keyraw` | `i_keyraw` | The raw key type |
+| `cmap_X_rmapped` | `i_valraw` | The raw mapped type |
+| `cmap_X_raw` | `struct { i_keyraw first; i_valraw second; }` | i_keyraw + i_valraw type |
| `cmap_X_result` | `struct { cmap_X_value *ref; bool inserted; }` | Result of insert/emplace |
| `cmap_X_iter` | `struct { cmap_X_value *ref; ... }` | Iterator type |