diff options
| author | Tyge Løvset <[email protected]> | 2021-01-20 13:04:26 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-01-20 13:04:26 +0100 |
| commit | 03303cddb4181b5679b17002d1dbf619d64a556f (patch) | |
| tree | 12d89072429e3e998592b4846d9afe7c057a36c1 /docs/cqueue_api.md | |
| parent | 6332a8a0db0533c7c7bb56f69064a5ce03e62b4a (diff) | |
| download | STC-modified-03303cddb4181b5679b17002d1dbf619d64a556f.tar.gz STC-modified-03303cddb4181b5679b17002d1dbf619d64a556f.zip | |
Moved types below API in docs.
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 96b46c64..8e200b36 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -14,15 +14,6 @@ a **cdeq_X** or **clist_X** type as underlying implementation, given as `ctype`. 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_rawvalue_t` | " | cqueue raw value type | -| `cqueue_X_iter_t` | " | cqueue iterator | - ## Header file All cqueue definitions and prototypes may be included in your C source file by including a single header file. @@ -56,6 +47,15 @@ cqueue_X_value_t* cqueue_X_itval(cqueue_X_iter_t it); cqueue_X_value_t cqueue_X_value_clone(cqueue_X_value_t val); ``` +## 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_rawvalue_t` | " | cqueue raw value type | +| `cqueue_X_iter_t` | " | cqueue iterator | + ## Examples ```c #include <stdio.h> |