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/cbits_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/cbits_api.md')
| -rw-r--r-- | docs/cbits_api.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/cbits_api.md b/docs/cbits_api.md index 9da2ad04..86b50f1e 100644 --- a/docs/cbits_api.md +++ b/docs/cbits_api.md @@ -5,13 +5,6 @@ A **cbits** represents a set of bits. It provides accesses to the value of indiv The **cbits** container is similar to the c++ class [std::bitset](https://en.cppreference.com/w/cpp/utility/bitset) and [boost::dynamic_bitset](https://www.boost.org/doc/libs/release/libs/dynamic_bitset/dynamic_bitset.html). -## Types - -| cbits | Type definition | Used to represent... | -|:--------------------|:--------------------------|:-----------------------------| -| `cbits` | `struct { ... }` | The cbits type | -| `cbits_iter_t` | `struct { ... }` | The cbits iterator type | - ## Header file All cstr definitions and prototypes may be included in your C source file by including a single header file. @@ -68,6 +61,13 @@ void cbits_next(cbits_iter_t* it); bool cbits_itval(cbits_iter_t it); ``` +## Types + +| cbits | Type definition | Used to represent... | +|:--------------------|:--------------------------|:-----------------------------| +| `cbits` | `struct { ... }` | The cbits type | +| `cbits_iter_t` | `struct { ... }` | The cbits iterator type | + ## Example ```c #include <stdio.h> |
