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/cdeq_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/cdeq_api.md')
| -rw-r--r-- | docs/cdeq_api.md | 24 |
1 files changed, 9 insertions, 15 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md index 7bc68b88..f118504a 100644 --- a/docs/cdeq_api.md +++ b/docs/cdeq_api.md @@ -24,21 +24,6 @@ be replaced by `my` in all of the following documentation. using_cdeq(str, cstr_t, cstr_compare_raw, cstr_del, cstr_from, cstr_to_raw, const char*) ``` -## Types - -| Type name | Type definition | Used to represent... | -|:---------------------|:------------------------------------|:-----------------------| -| `cdeq_X` | `struct { cdeq_X_value_t* data; }` | The cdeq type | -| `cdeq_X_value_t` | `Value` | The cdeq value type | -| `cdeq_X_rawvalue_t` | `RawValue` | The raw value type | -| `cdeq_X_iter_t` | `struct { cdeq_X_value_t* ref; }` | The iterator type | - -## Constants and macros - -| Name | Purpose | -|:---------------------------|:---------------------| -| `cdeq_inits` | Initializer constant | - ## Header file All cdeq definitions and prototypes may be included in your C source file by including a single header file. @@ -109,6 +94,15 @@ size_t cdeq_X_index(const cdeq_X deq, cdeq_X_iter_t it); cdeq_X_value_t cdeq_X_value_clone(cdeq_X_value_t val); ``` +## Types + +| Type name | Type definition | Used to represent... | +|:---------------------|:------------------------------------|:-----------------------| +| `cdeq_X` | `struct { cdeq_X_value_t* data; }` | The cdeq type | +| `cdeq_X_value_t` | `Value` | The cdeq value type | +| `cdeq_X_rawvalue_t` | `RawValue` | The raw value type | +| `cdeq_X_iter_t` | `struct { cdeq_X_value_t* ref; }` | The iterator type | + ## Examples ```c #include <stdio.h> |