summaryrefslogtreecommitdiffhomepage
path: root/docs/cqueue_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-19 13:08:05 +0100
committerTyge Løvset <[email protected]>2021-03-19 13:08:05 +0100
commit60786d8b27e9c622c43ddc8e77575c0853728014 (patch)
tree7fd6ab6963de42b11276f4ce57fc177ba4496848 /docs/cqueue_api.md
parent0183aa814b21de2f623b56d79ac0f44a2bbb0366 (diff)
downloadSTC-modified-60786d8b27e9c622c43ddc8e77575c0853728014.tar.gz
STC-modified-60786d8b27e9c622c43ddc8e77575c0853728014.zip
Added clear() to cpque, cstack, cqueue, cbits, even though not in STL. Code/docs formatting.
Diffstat (limited to 'docs/cqueue_api.md')
-rw-r--r--docs/cqueue_api.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 30b6d4d0..d1f889f0 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -11,7 +11,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
+`X` is a type tag name and will affect the names of all cqueue types and methods. E.g. declaring
`using_cqueue(i, clist_i)`, `X` should be replaced by `i` in all of the following documentation.
## Header file
@@ -27,6 +27,8 @@ All cqueue definitions and prototypes are available by including a single header
```c
cqueue_X cqueue_X_init(void);
cqueue_X cqueue_X_clone(cqueue_X q);
+
+void cqueue_X_clear(cqueue_X* self);
void cqueue_X_del(cqueue_X* self); // destructor
size_t cqueue_X_size(cqueue_X q);