diff options
| author | Tyge Løvset <[email protected]> | 2020-12-03 20:56:26 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-12-03 20:56:26 +0100 |
| commit | 3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e (patch) | |
| tree | fa1584e0023fc553b17511bf4b186ba388939be6 /docs/cqueue_api.md | |
| parent | 870a601a62c804f9d15efe5856cc6018b076dfe6 (diff) | |
| download | STC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.tar.gz STC-modified-3b3f4493618b3aa5edb99c91e0ff0ea95fdb372e.zip | |
More docs descriptions.
Diffstat (limited to 'docs/cqueue_api.md')
| -rw-r--r-- | docs/cqueue_api.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md index 71f1db6f..e6951493 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -7,9 +7,8 @@ This describes the API of the queue type **cqueue**. ```c #define using_cqueue(X, ctype) ``` -The macro `using_cqueue()` must be instantiated in the global scope. -**cqueue** uses normally a **clist** type as underlying implementation, given as `ctype`. -Default values are given above for args not specified. `X` is a type tag name and +The macro `using_cqueue()` must be instantiated in the global scope. **cqueue** uses normally +a **clist** type as underlying implementation, given as `ctype`. `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. @@ -28,7 +27,7 @@ will affect the names of all cqueue types and methods. E.g. declaring `using_cqu All cqueue definitions and prototypes may be included in your C source file by including a single header file. ```c -#include "stc/cqueue.h" +#include "stc/cqueue.h" /* includes default underlying implementation header clist.h */ ``` ## Methods |
