summaryrefslogtreecommitdiffhomepage
path: root/docs/csset_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-01-20 13:04:26 +0100
committerTyge Løvset <[email protected]>2021-01-20 13:04:26 +0100
commit03303cddb4181b5679b17002d1dbf619d64a556f (patch)
tree12d89072429e3e998592b4846d9afe7c057a36c1 /docs/csset_api.md
parent6332a8a0db0533c7c7bb56f69064a5ce03e62b4a (diff)
downloadSTC-modified-03303cddb4181b5679b17002d1dbf619d64a556f.tar.gz
STC-modified-03303cddb4181b5679b17002d1dbf619d64a556f.zip
Moved types below API in docs.
Diffstat (limited to 'docs/csset_api.md')
-rw-r--r--docs/csset_api.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/docs/csset_api.md b/docs/csset_api.md
index 23510763..4aded6a8 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -20,19 +20,6 @@ be replaced by `my` in all of the following documentation.
`using_csset_str()` is a predefined macro for `using_csset(str, cstr_t, ...)`.
-## Types
-
-| Type name | Type definition | Used to represent... |
-|:---------------------|:---------------------------------------|:-------------------------|
-| `csset_X` | `struct { ... }` | The csset type |
-| `csset_X_rawkey_t` | `RawKey` | The raw key type |
-| `csset_X_rawvalue_t` | `csset_X_rawkey_t` | The raw key type |
-| `csset_X_key_t` | `Key` | The key type |
-| `csset_X_value_t` | `csset_X_key_t` | The value type |
-| `csset_X_result_t` | `struct { Key first; bool second; }` | Result of insert/emplace |
-| `csset_X_iter_t` | `struct { csset_X_value_t *ref; ... }` | Iterator type |
-
-
## Header file
All csset definitions and prototypes may be included in your C source file by including a single header file.
@@ -73,6 +60,18 @@ csset_X_value_t csset_X_value_clone(csset_X_value_t val);
void csset_X_value_del(csset_X_value_t* val);
```
+## Types
+
+| Type name | Type definition | Used to represent... |
+|:---------------------|:---------------------------------------|:-------------------------|
+| `csset_X` | `struct { ... }` | The csset type |
+| `csset_X_rawkey_t` | `RawKey` | The raw key type |
+| `csset_X_rawvalue_t` | `csset_X_rawkey_t` | The raw key type |
+| `csset_X_key_t` | `Key` | The key type |
+| `csset_X_value_t` | `csset_X_key_t` | The value type |
+| `csset_X_result_t` | `struct { Key first; bool second; }` | Result of insert/emplace |
+| `csset_X_iter_t` | `struct { csset_X_value_t *ref; ... }` | Iterator type |
+
## Example
```c
#include <stdio.h>