summaryrefslogtreecommitdiffhomepage
path: root/docs/cbits_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2023-02-01 10:12:22 +0100
committerTyge Løvset <[email protected]>2023-02-01 10:12:22 +0100
commita8998a52082f86a71bf152c5baa9ebc005871142 (patch)
treee231d86dba26d1495b893432fde7db17ac3eac08 /docs/cbits_api.md
parent6ce6ef3307e52db5813d3c8d6a2cba52df06daf8 (diff)
downloadSTC-modified-a8998a52082f86a71bf152c5baa9ebc005871142.tar.gz
STC-modified-a8998a52082f86a71bf152c5baa9ebc005871142.zip
Update docs formatting and README.md
Diffstat (limited to 'docs/cbits_api.md')
-rw-r--r--docs/cbits_api.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/cbits_api.md b/docs/cbits_api.md
index 726fb68b..f3967739 100644
--- a/docs/cbits_api.md
+++ b/docs/cbits_api.md
@@ -21,25 +21,25 @@ All cbits definitions and prototypes are available by including a single header
```c
cbits cbits_init(void);
cbits cbits_from(const char* str);
-cbits cbits_with_size(intptr_t size, bool value); // size must be <= N if N is defined
+cbits cbits_with_size(intptr_t size, bool value); // size must be <= N if N is defined
cbits cbits_with_pattern(intptr_t size, uint64_t pattern);
cbits cbits_clone(cbits other);
void cbits_clear(cbits* self);
cbits* cbits_copy(cbits* self, const cbits* other);
-void cbits_resize(cbits* self, intptr_t size, bool value); // only if i_len is not defined
+void cbits_resize(cbits* self, intptr_t size, bool value); // only if i_len is not defined
void cbits_drop(cbits* self);
-cbits* cbits_take(cbits* self, const cbits* other); // give other to self
-cbits cbits_move(cbits* self); // transfer self to caller
+cbits* cbits_take(cbits* self, const cbits* other); // give other to self
+cbits cbits_move(cbits* self); // transfer self to caller
intptr_t cbits_size(const cbits* self);
-intptr_t cbits_count(const cbits* self); // count number of bits set
+intptr_t cbits_count(const cbits* self); // count number of bits set
bool cbits_test(const cbits* self, intptr_t i);
-bool cbits_at(const cbits* self, intptr_t i); // same as cbits_test()
+bool cbits_at(const cbits* self, intptr_t i); // same as cbits_test()
bool cbits_subset_of(const cbits* self, const cbits* other); // is set a subset of other?
-bool cbits_disjoint(const cbits* self, const cbits* other); // no common bits
+bool cbits_disjoint(const cbits* self, const cbits* other); // no common bits
char* cbits_to_str(const cbits* self, char* str, intptr_t start, intptr_t stop);
void cbits_set(cbits* self, intptr_t i);
@@ -52,7 +52,7 @@ void cbits_flip(cbits* self, intptr_t i);
void cbits_intersect(cbits* self, const cbits* other);
void cbits_union(cbits* self, const cbits* other);
-void cbits_xor(cbits* self, const cbits* other); // set of disjoint bits
+void cbits_xor(cbits* self, const cbits* other); // set of disjoint bits
```
## Types