summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-03 22:24:16 +0100
committerTyge Løvset <[email protected]>2021-01-03 22:24:16 +0100
commita5207f9968504a52f3c815e060403a48a9f5a734 (patch)
tree91a9d051469e4e17ef8bb62f7812f50971153378
parent63fcbb1d984c505175a9a6eb2e40d2ea8eb39e7b (diff)
downloadSTC-modified-a5207f9968504a52f3c815e060403a48a9f5a734.tar.gz
STC-modified-a5207f9968504a52f3c815e060403a48a9f5a734.zip
Fixed errors in documentations.
-rw-r--r--docs/carray_api.md2
-rw-r--r--docs/cbitset_api.md2
-rw-r--r--docs/cdeq_api.md4
-rw-r--r--docs/clist_api.md2
-rw-r--r--docs/cmap_api.md2
-rw-r--r--docs/copt_api.md4
-rw-r--r--docs/cpque_api.md2
-rw-r--r--docs/cset_api.md5
-rw-r--r--docs/cstr_api.md4
-rw-r--r--docs/cvec_api.md2
10 files changed, 14 insertions, 15 deletions
diff --git a/docs/carray_api.md b/docs/carray_api.md
index de679c97..39ecdcbd 100644
--- a/docs/carray_api.md
+++ b/docs/carray_api.md
@@ -11,7 +11,7 @@ See [boost::multi_array](https://www.boost.org/doc/libs/release/libs/multi_array
#define using_carray(X, Value, valueDestroy=c_default_del,
valueClone=c_default_clone)
```
-The macro `using_carray()` can be instantiated with 2 or 3 arguments in the global scope.
+The macro `using_carray()` can be instantiated with 2 or 4 arguments in the global scope.
Default values are given above for args not specified. `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`.
diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md
index dde8f68e..7a5f1210 100644
--- a/docs/cbitset_api.md
+++ b/docs/cbitset_api.md
@@ -1,7 +1,7 @@
# STC Container [cbitset](../stc/cbitset.h): Bitset
![Bitset](pics/bitset.jpg)
-This describes the API of type **cbitset**. See [std::bitset](https://en.cppreference.com/w/cpp/utility/bitset) or
+A **cbitset** represents a resizable sequence of N bits. Bitsets can be manipulated by standard logic operators and converted to and from strings and integers. See [std::bitset](https://en.cppreference.com/w/cpp/utility/bitset) or
[boost::dynamic_bitset](https://www.boost.org/doc/libs/release/libs/dynamic_bitset/dynamic_bitset.html) for similar c++ classes.
## Types
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 506e93bd..5ba9b356 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -1,4 +1,4 @@
-# STC Container [cdeq](../stc/cdeq.h): Double Ended Queue (Deque)
+# STC Container [cdeq](../stc/cdeq.h): Double Ended Queue
![Deque](pics/deque.jpg)
A **cdeq** is an indexed sequence container that allows fast insertion and deletion at both its beginning and its end.
@@ -14,7 +14,7 @@ See [std::deque](https://en.cppreference.com/w/cpp/container/deque) for a simila
RawValue=Value)
#define using_cdeq_str()
```
-The macro `using_cdeq()` can be instantiated with 2, 3, 4, 5, or 7 arguments in the global scope.
+The macro `using_cdeq()` can be instantiated with 2, 3, 5, or 7 arguments in the global scope.
Defaults values are given above for args not specified. `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.
diff --git a/docs/clist_api.md b/docs/clist_api.md
index 361d82ff..7badccbb 100644
--- a/docs/clist_api.md
+++ b/docs/clist_api.md
@@ -16,7 +16,7 @@ is only one pointer, and length of the list is not stored. The method *clist_X_s
RawValue=Value)
#define using_clist_str()
```
-The macro `using_clist()` can be instantiated with 2, 3, 4, 5, or 7 arguments in the global scope.
+The macro `using_clist()` can be instantiated with 2, 3, 5, or 7 arguments in the global scope.
Default values are given above for args not specified. `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
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index f4ef9172..0ef6441f 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -33,7 +33,7 @@ See [std::unordered_map](https://en.cppreference.com/w/cpp/container/unordered_m
RawKey=Key)
#define using_cmap_str()
```
-The macro `using_cmap()` can be instantiated with 3, 4, 5, 7, 9, 11, or 13 arguments in the global scope.
+The macro `using_cmap()` can be instantiated with 3, 5, 7, 9, 11, or 13 arguments in the global scope.
Default values are given above for args not specified. `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.
diff --git a/docs/copt_api.md b/docs/copt_api.md
index 79a35c37..df49f66d 100644
--- a/docs/copt_api.md
+++ b/docs/copt_api.md
@@ -1,7 +1,7 @@
# STC Module [copt](../stc/copt.h): Command line argument parsing
-This describes the API of string type *copt_get()* function for command line argument parsing.
-See [getopt_long](https://www.freebsd.org/cgi/man.cgi?getopt_long(3)) for a similar freebsd function.
+This describes the API of the *copt_get()* function for command line argument parsing.
+See [getopt_long](https://www.freebsd.org/cgi/man.cgi?getopt_long(3)) for a similar posix function.
## Types
diff --git a/docs/cpque_api.md b/docs/cpque_api.md
index c824e9f1..ab9e8117 100644
--- a/docs/cpque_api.md
+++ b/docs/cpque_api.md
@@ -1,6 +1,6 @@
# STC Container [cpque](../stc/cpque.h): Priority Queue
-This describes the API of the priority queue type **cpque**. Implemented as a heap.
+This describes the API of the priority queue type **cpque**. It is implemented as a heap.
See [std::priority_queue](https://en.cppreference.com/w/cpp/container/priority_queue) for a similar c++ class.
## Declaration
diff --git a/docs/cset_api.md b/docs/cset_api.md
index f8d33e2b..70ca0d8c 100644
--- a/docs/cset_api.md
+++ b/docs/cset_api.md
@@ -6,16 +6,15 @@ A **cset** is an associative container that contains a set of unique objects of
## Declaration
```c
-#define using_cset_str()
-
#define using_cset(X, Key, keyEqualsRaw=c_default_equals,
keyHashRaw=c_default_hash,
keyDestroy=c_default_del,
keyFromRaw=c_default_clone,
keyToRaw=c_default_to_raw,
RawKey=Key)
+#define using_cset_str()
```
-The macro `using_cset()` can be instantiated with 2, 4, 5, or 8 arguments in the global scope.
+The macro `using_cset()` can be instantiated with 2, 4, 6, or 8 arguments in the global scope.
Default values are given above for args not specified. `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.
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 97cc0e4b..11a2e75c 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,14 +1,14 @@
# STC Container [cstr](../stc/cstr.h): String
![String](pics/string.jpg)
-This describes the API of string type **cstr_t**.
+This describes the API of string type **cstr**.
See [std::basic_string](https://en.cppreference.com/w/cpp/string/basic_string) for a similar c++ class.
## Types
| Type name | Type definition | Used to represent... |
|:------------------|:---------------------------------|:---------------------------|
-| `cstr_t` | `struct { const char *str; }` | The string type |
+| `cstr, cstr_t` | `struct { const char *str; }` | The string type |
| `cstr_value_t` | `char` | The string element type |
| `cstr_iter_t` | `struct { cstr_value_t *ref; }` | cstr_t iterator |
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 6e2ea713..2a79f3d7 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -14,7 +14,7 @@ See [std::vector](https://en.cppreference.com/w/cpp/container/vector) for a simi
RawValue=Value)
#define using_cvec_str()
```
-The macro `using_cvec()` can be instantiated with 2, 3, 4, 5, or 7 arguments in the global scope.
+The macro `using_cvec()` can be instantiated with 2, 3, 5, or 7 arguments in the global scope.
Defaults values are given above for args not specified. `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.