summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2023-02-16 19:13:52 +0100
committerTyge Løvset <[email protected]>2023-02-16 19:13:52 +0100
commit8864c11b2b85f832ce746a902b43ecf170e2eebc (patch)
tree8f5f51456182b96e0feb6b5869576033ed962ad6 /docs
parent290055ad96c22fd9dfb539d0217e45cd2f1cdb91 (diff)
downloadSTC-modified-8864c11b2b85f832ce746a902b43ecf170e2eebc.tar.gz
STC-modified-8864c11b2b85f832ce746a902b43ecf170e2eebc.zip
Reverted and removed maps put function. Renamed clist node api functions. Minor fix in template.h
Diffstat (limited to 'docs')
-rw-r--r--docs/clist_api.md10
-rw-r--r--docs/cmap_api.md1
-rw-r--r--docs/csmap_api.md1
3 files changed, 5 insertions, 7 deletions
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 3e73d42b..45721f8d 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -79,15 +79,15 @@ clist_X_iter clist_X_find_in(clist_X_iter it1, clist_X_iter it2, i_valraw
const i_val* clist_X_get(const clist_X* self, i_valraw raw);
i_val* clist_X_get_mut(clist_X* self, i_valraw raw);
-void clist_X_sort(clist_X* self);
+void clist_X_sort(clist_X* self); // needs i_extern once
void clist_X_reverse(clist_X* self);
// Node API
clist_X_node* clist_X_get_node(clist_X_value* val); // get the enclosing node
-clist_X_value* clist_X_push_node_back(clist_X* self, clist_X_node* node);
-clist_X_value* clist_X_insert_node_after(clist_X* self, clist_X_node* ref, clist_X_node* node);
-clist_X_node* clist_X_unlink_node_after(clist_X* self, clist_X_node* ref); // return the unlinked node
-void clist_X_erase_node_after(clist_X* self, clist_X_node* node);
+clist_X_value* clist_X_push_back_node(clist_X* self, clist_X_node* node);
+clist_X_value* clist_X_insert_after_node(clist_X* self, clist_X_node* ref, clist_X_node* node);
+clist_X_node* clist_X_unlink_after_node(clist_X* self, clist_X_node* ref); // return the unlinked node
+void clist_X_erase_after_node(clist_X* self, clist_X_node* node);
clist_X_iter clist_X_begin(const clist_X* self);
clist_X_iter clist_X_end(const clist_X* self);
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 998146a7..bf3dddcc 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -75,7 +75,6 @@ cmap_X_result cmap_X_push(cmap_X* self, cmap_X_value entry);
cmap_X_result cmap_X_emplace(cmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map
cmap_X_result cmap_X_emplace_or_assign(cmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update
-cmap_X_result cmap_X_put(cmap_X* self, i_keyraw rkey, i_valraw rmapped); // emplace_or_assign() alias
int cmap_X_erase(cmap_X* self, i_keyraw rkey); // return 0 or 1
cmap_X_iter cmap_X_erase_at(cmap_X* self, cmap_X_iter it); // return iter after it
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 89948369..8e5780e3 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -74,7 +74,6 @@ csmap_X_result csmap_X_push(csmap_X* self, csmap_X_value entry);
csmap_X_result csmap_X_emplace(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // no change if rkey in map
csmap_X_result csmap_X_emplace_or_assign(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // always update rmapped
-csmap_X_result csmap_X_put(csmap_X* self, i_keyraw rkey, i_valraw rmapped); // csmap_X_emplace_or_assign() alias
int csmap_X_erase(csmap_X* self, i_keyraw rkey);
csmap_X_iter csmap_X_erase_at(csmap_X* self, csmap_X_iter it); // returns iter after it