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/cstack_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/cstack_api.md')
| -rw-r--r-- | docs/cstack_api.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/cstack_api.md b/docs/cstack_api.md index 5a2516b8..b32e9dc5 100644 --- a/docs/cstack_api.md +++ b/docs/cstack_api.md @@ -14,15 +14,6 @@ a **cvec_X** or **cdeq_X** type as underlying implementation, given as `ctype`. affect the names of all cstack types and methods. E.g. declaring `using_cstack(my, cvec_my);`, `X` should be replaced by `my` in all of the following documentation. -## Types - -| Type name | Type definition | Used to represent... | -|:----------------------|:---------------------------------------|:----------------------------| -| `cstack_X` | Depends on underlying container type | The cstack type | -| `cstack_X_value_t` | " | The cstack element type | -| `cstack_X_rawvalue_t` | " | cstack raw value type | -| `cstack_X_iter_t` | " | cstack iterator | - ## Header file All cstack definitions and prototypes may be included in your C source file by including a single header file. @@ -55,6 +46,15 @@ cstack_X_value_t* cstack_X_itval(cstack_X_iter_t it); cstack_X_value_t cstack_X_value_clone(cstack_X_value_t val); ``` +## Types + +| Type name | Type definition | Used to represent... | +|:----------------------|:---------------------------------------|:----------------------------| +| `cstack_X` | Depends on underlying container type | The cstack type | +| `cstack_X_value_t` | " | The cstack element type | +| `cstack_X_rawvalue_t` | " | cstack raw value type | +| `cstack_X_iter_t` | " | cstack iterator | + ## Example ```c #include <stdio.h> |