summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-12-30 11:17:30 +0100
committerTyge Løvset <[email protected]>2020-12-30 11:17:30 +0100
commit2b46410ef5bb28c4551cdd422c5e22731bd6b610 (patch)
tree03408e3fb036ca610b81e2dccdbec9740605b074 /docs
parente2de45078c5e668ed9fd0515eb8face9170b9f70 (diff)
downloadSTC-modified-2b46410ef5bb28c4551cdd422c5e22731bd6b610.tar.gz
STC-modified-2b46410ef5bb28c4551cdd422c5e22731bd6b610.zip
API change: Swapped destroy <-> compare function args in using_*() macros for cvec, cdeq, cptr and clist.
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md4
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cptr_api.md8
-rw-r--r--docs/cvec_api.md4
4 files changed, 10 insertions, 10 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index db9051f9..9f72406f 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -5,8 +5,8 @@ This describes the API of vector type **cdeq**.
## Declaration
```c
-#define using_cdeq(X, Value, valueDestroy=c_default_del,
- valueCompareRaw=c_default_compare,
+#define using_cdeq(X, Value, valueCompareRaw=c_default_compare,
+ valueDestroy=c_default_del,
RawValue=Value,
valueToRaw=c_default_to_raw,
valueFromRaw=c_default_from_raw)
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 9ed0ea31..e3673492 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -6,8 +6,8 @@ Implemented as a circular singly linked list. Also supports various *splice* fun
## Declaration
```c
-#define using_clist(X, Value, valueDestroy=c_default_del,
- valueCompareRaw=c_default_compare,
+#define using_clist(X, Value, valueCompareRaw=c_default_compare,
+ valueDestroy=c_default_del,
RawValue=Value,
valueToRaw=c_default_to_raw,
valueFromRaw=c_default_from_raw)
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 560db243..2d626fa8 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -7,11 +7,11 @@ This describes the API of the pointer type **cptr** and the shared pointer type
## Declaration
```c
-#define using_cptr(X, Value, valueDestroy=c_default_del,
- valueCompare=c_default_compare)
+#define using_cptr(X, Value, valueCompare=c_default_compare,
+ valueDestroy=c_default_del)
-#define using_csptr(X, Value, valueDestroy=c_default_del,
- valueCompare=c_default_compare)
+#define using_csptr(X, Value, valueCompare=c_default_compare,
+ valueDestroy=c_default_del)
```
The macro `using_cptr()` must be instantiated in the global scope. `X` is a type tag name and will
affect the names of all cptr types and methods. E.g. declaring `using_cptr(my, cvec_my);`,
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 27667f13..8b6f751f 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -5,8 +5,8 @@ This describes the API of vector type **cvec**.
## Declaration
```c
-#define using_cvec(X, Value, valueDestroy=c_default_del,
- valueCompareRaw=c_default_compare,
+#define using_cvec(X, Value, valueCompareRaw=c_default_compare,
+ valueDestroy=c_default_del,
RawValue=Value,
valueToRaw=c_default_to_raw,
valueFromRaw=c_default_from_raw)