diff options
| author | Tyge Løvset <[email protected]> | 2020-12-03 14:22:01 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2020-12-03 14:22:01 +0100 |
| commit | 870a601a62c804f9d15efe5856cc6018b076dfe6 (patch) | |
| tree | cdd38bfd44bd12b17f682b09163bf06039c9db5e /docs/cqueue_api.md | |
| parent | 79be0ee109904542ed0ece119c0432f4b629cd44 (diff) | |
| download | STC-modified-870a601a62c804f9d15efe5856cc6018b076dfe6.tar.gz STC-modified-870a601a62c804f9d15efe5856cc6018b076dfe6.zip | |
Some more fixes.
Diffstat (limited to 'docs/cqueue_api.md')
| -rw-r--r-- | docs/cqueue_api.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md index deab08f6..71f1db6f 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -5,23 +5,23 @@ This describes the API of the queue type **cqueue**. ## Declaration ```c -#define using_cqueue(X, CType) +#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. +**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 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. ## Types -| Type name | Type definition | Used to represent... | -|:----------------------|:---------------------------------------|:------------------------------------| -| `cqueue_X` | Depends on underlying container type | The cqueue type | -| `cqueue_X_value_t` | | The cqueue element type | -| `cqueue_X_input_t` | | cqueue input type | -| `cqueue_X_rawvalue_t` | | cqueue raw value type | -| `cqueue_X_iter_t` | | cqueue iterator | +| Type name | Type definition | Used to represent... | +|:----------------------|:---------------------------------------|:-------------------------| +| `cqueue_X` | Depends on underlying container type | The cqueue type | +| `cqueue_X_value_t` | " | The cqueue element type | +| `cqueue_X_input_t` | " | cqueue input type | +| `cqueue_X_rawvalue_t` | " | cqueue raw value type | +| `cqueue_X_iter_t` | " | cqueue iterator | ## Header file |