summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-02-22 14:37:45 +0100
committerTyge Løvset <[email protected]>2021-02-22 14:37:45 +0100
commitd05737c48813a077976da385d8922f3b17400b80 (patch)
tree511a6686160053aeaef9d9868b6a7c8f413e9423 /docs
parent23ec0fe83e8efbc3a758af4049ce990ee67ea47c (diff)
downloadSTC-modified-d05737c48813a077976da385d8922f3b17400b80.tar.gz
STC-modified-d05737c48813a077976da385d8922f3b17400b80.zip
Minor map doc fix and cleanups.
Diffstat (limited to 'docs')
-rw-r--r--docs/carray_api.md4
-rw-r--r--docs/cdeq_api.md4
-rw-r--r--docs/clist_api.md4
-rw-r--r--docs/cmap_api.md4
-rw-r--r--docs/cpque_api.md2
-rw-r--r--docs/cptr_api.md4
-rw-r--r--docs/cqueue_api.md2
-rw-r--r--docs/cset_api.md4
-rw-r--r--docs/csmap_api.md4
-rw-r--r--docs/csset_api.md4
-rw-r--r--docs/cstack_api.md4
-rw-r--r--docs/cvec_api.md4
12 files changed, 22 insertions, 22 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index 90fc3815..7dabba41 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -13,8 +13,8 @@ using_carray(X, Value);
using_carray(X, Value, valueDel, valueClone);
```
The macro `using_carray()` must be instantiated in the global scope. `X` and `N` are type tags and
-will affect the names of all cset types and methods. E.g. declaring `using_carray(my, int);`, `X` should
-be replaced by `my` in all of the following documentation. The `N` character should be replaced by `1`, `2` or `3`.
+will affect the names of all cset types and methods. E.g. declaring `using_carray(i, int);`, `X` should
+be replaced by `i` in all of the following documentation. The `N` character should be replaced by `1`, `2` or `3`.
## Header file
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 10a9cd74..81ad703c 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -16,8 +16,8 @@ using_cdeq(X, Value, valueCompareRaw, valueDel, valueFromRaw, valueToRaw, RawVal
using_cdeq_str();
```
The macro `using_cdeq()` must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all cdeq types and methods. E.g. declaring `using_cdeq(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all cdeq types and methods. E.g. declaring `using_cdeq(i, int);`, `X` should
+be replaced by `i` in all of the following documentation.
`using_cdeq_str()` is a shorthand for:
```
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 5a8cea31..a9550fe7 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -25,8 +25,8 @@ using_clist(X, Value, valueCompareRaw, valueDel, valueFromRaw, valueToRaw, RawVa
using_clist_str()
```
The macro `using_clist()` must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all clist types and methods. E.g. declaring `using_clist(my, int);`, `X` should
-be replaced by `my` in all of the following documentation. `using_clist_str()` is a shorthand for
+will affect the names of all clist types and methods. E.g. declaring `using_clist(i, int);`, `X` should
+be replaced by `i` in all of the following documentation. `using_clist_str()` is a shorthand for
```c
using_clist(str, cstr_t, cstr_compare_raw, cstr_del, cstr_from, cstr_c_str, const char*)
```
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 11397371..ec5d3dd1 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -30,8 +30,8 @@ using_cmap_strval(X, Key, keyEqualsRaw, keyHashRaw, keyDel, keyFromRaw, keyToRaw
using_cmap_str() // using_cmap(str, cstr, cstr, ...)
```
The `using_cmap()` macro family must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all cmap types and methods. E.g. declaring `using_cmap(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all cmap types and methods. E.g. declaring `using_cmap(ii, int, int);`, `X` should
+be replaced by `ii` in all of the following documentation.
## Header file
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index aa62a3c3..8d79c627 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -16,7 +16,7 @@ or **cdeq_X** as underlying implementation, specified as `ctype`. The *direction
Note that the function *`ctype`_value_compare(x, y)* defined by the underlying vector type is used to
compare values (priorities). `X` is a type tag name and will affect the names of all cpque types and methods.
-Declaring `using_cpque(my, cvec_my, >)`, `X` should be replaced by `my` in the following documentation.
+Declaring `using_cpque(i, cvec_i, >)`, `X` should be replaced by `i` in the following documentation.
## Header file
diff --git a/docs/cptr_api.md b/docs/cptr_api.md
index 23cb4d41..6ddca701 100644
--- a/docs/cptr_api.md
+++ b/docs/cptr_api.md
@@ -18,8 +18,8 @@ using_csptr(X, Value, valueCompare);
using_csptr(X, Value, valueCompare, valueDel);
```
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);`,
-`X` should be replaced by `my` in all of the following documentation.
+affect the names of all cptr types and methods. E.g. declaring `using_cptr(v4, Vec4);`,
+`X` should be replaced by `v4` in all of the following documentation.
## Header file
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index c5429ff6..40a0796f 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -12,7 +12,7 @@ using_cqueue(X, ctype)
The macro `using_cqueue()` must be instantiated in the global scope. **cqueue** uses normally
a **cdeq_X** or **clist_X** type as underlying implementation, given as `ctype`. See example below for usage.
`X` is a type tag name and will affect the names of all cqueue types and methods. E.g. declaring
-`using_cqueue(my, clist_my)`, `X` should be replaced by `my` in all of the following documentation.
+`using_cqueue(i, clist_i)`, `X` should be replaced by `i` in all of the following documentation.
## Header file
diff --git a/docs/cset_api.md b/docs/cset_api.md
index 45df2afb..6f40ea95 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -14,8 +14,8 @@ using_cset(X, Key, keyEqualsRaw, keyHashRaw, keyDel, keyFromRaw, keyToRaw, RawKe
using_cset_str();
```
The macro `using_cset()` must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all cset types and methods. E.g. declaring `using_cset(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all cset types and methods. E.g. declaring `using_cset(i, int);`, `X` should
+be replaced by `i` in all of the following documentation.
`using_cset_str()` is a predefined macro for `using_cset(str, cstr, ...)`.
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 96087706..93341d39 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -29,8 +29,8 @@ using_csmap_strval(X, Key, keyCompareRaw, keyDel, keyFromRaw, keyToRaw, RawKey);
using_csmap_str(); // using_csmap(str, cstr, cstr, ...)
```
The `using_csmap()` macro family must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all csmap types and methods. E.g. declaring `using_csmap(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all csmap types and methods. E.g. declaring `using_csmap(ii, int, int);`, `X` should
+be replaced by `ii` in all of the following documentation.
## Header file
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 96f7357a..e2edda7d 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -15,8 +15,8 @@ using_csset(X, Key, keyCompareRaw, keyDel, keyFromRaw, keyToRaw, RawKey);
using_csset_str();
```
The macro `using_csset()` must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all csset types and methods. E.g. declaring `using_csset(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all csset types and methods. E.g. declaring `using_csset(i, int);`, `X` should
+be replaced by `i` in all of the following documentation.
`using_csset_str()` is a predefined macro for `using_csset(str, cstr, ...)`.
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 37b21497..34d03c8e 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -12,8 +12,8 @@ using_cstack(X, ctype)
```
The macro `using_cstack()` must be instantiated in the global scope. **cstack** uses normally
a **cvec_X** or **cdeq_X** type as underlying implementation, given as `ctype`. `X` is a type tag name and will
-affect the names of all cstack types and methods. E.g. declaring `using_cstack(my, cvec_my);`,
-`X` should be replaced by `my` in all of the following documentation.
+affect the names of all cstack types and methods. E.g. declaring `using_cstack(i, cvec_i);`,
+`X` should be replaced by `i` in all of the following documentation.
## Header file
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index d3ac1e10..07d18e68 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -20,8 +20,8 @@ using_cvec(X, Value, valueCompareRaw, valueDel, valueFromRaw, valueToRaw, RawVal
using_cvec_str()
```
The macro `using_cvec()` must be instantiated in the global scope. `X` is a type tag name and
-will affect the names of all cvec types and methods. E.g. declaring `using_cvec(my, int);`, `X` should
-be replaced by `my` in all of the following documentation.
+will affect the names of all cvec types and methods. E.g. declaring `using_cvec(i, int);`, `X` should
+be replaced by `i` in all of the following documentation.
`using_cvec_str()` is a shorthand for:
```