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/cpque_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/cpque_api.md')
| -rw-r--r-- | docs/cpque_api.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/cpque_api.md b/docs/cpque_api.md index 10a40043..276f1ce3 100644 --- a/docs/cpque_api.md +++ b/docs/cpque_api.md @@ -19,14 +19,6 @@ Note that the function `{ctype}_value_compare(x, y)` defined by the underlying v compare values (priorities). `X` is a type tag name and will affect the names of all cpque types and methods. Declaring `using_cpque(my, cvec_my, >);`, `X` should be replaced by `my` in the following documentation. -## Types - -| Type name | Type definition | Used to represent... | -|:---------------------|:--------------------------------------|:------------------------| -| `cpque_X` | `struct {cpque_X_value_t* data; ...}` | The cpque type | -| `cpque_X_value_t` | Depends on underlying container type | The cpque element type | -| `cpque_X_rawvalue_t` | " | cpque raw value type | - ## Header file All cpque definitions and prototypes may be included in your C source file by including a single header file. @@ -57,6 +49,14 @@ void cpque_X_erase_at(cpque_X* self, size_t idx); cpque_X_value_t cpque_X_value_clone(cpque_X_value_t val); ``` +## Types + +| Type name | Type definition | Used to represent... | +|:---------------------|:--------------------------------------|:------------------------| +| `cpque_X` | `struct {cpque_X_value_t* data; ...}` | The cpque type | +| `cpque_X_value_t` | Depends on underlying container type | The cpque element type | +| `cpque_X_rawvalue_t` | " | cpque raw value type | + ## Example ```c #include <stdio.h> |
