From 3a384a338654672a0ccdfa6cba101e3872775af2 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Sat, 2 Jan 2021 23:04:57 +0100 Subject: Some docs updates. --- docs/cbitset_api.md | 5 +++-- docs/ccommon_api.md | 26 ++++++++++++++++++++++++++ docs/cmap_api.md | 1 + docs/containers-small.jpg | Bin 96093 -> 0 bytes docs/containers.jpg | Bin 0 -> 96093 bytes docs/cset_api.md | 1 + 6 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 docs/ccommon_api.md delete mode 100644 docs/containers-small.jpg create mode 100644 docs/containers.jpg diff --git a/docs/cbitset_api.md b/docs/cbitset_api.md index 70f324fe..7da433b2 100644 --- a/docs/cbitset_api.md +++ b/docs/cbitset_api.md @@ -24,6 +24,8 @@ All cstr definitions and prototypes may be included in your C source file by inc cbitset_t cbitset_init(void); cbitset_t cbitset_with_size(size_t size, bool value); cbitset_t cbitset_from_str(const char* str); + +cbitset_t cbitset_clone(cbitset_t other); void cbitset_resize(cbitset_t* self, size_t size, bool value); cbitset_t cbitset_intersect(cbitset_t s1, cbitset_t s2); @@ -33,9 +35,8 @@ cbitset_t cbitset_not(cbitset_t s1); void cbitset_del(cbitset_t* self); -cbitset_t* cbitset_take(cbitset_t* self, cbitset_t other); cbitset_t* cbitset_assign(cbitset_t* self, cbitset_t other); -cbitset_t cbitset_clone(cbitset_t other); +cbitset_t* cbitset_take(cbitset_t* self, cbitset_t other); cbitset_t cbitset_move(cbitset_t* self); size_t cbitset_size(cbitset_t set); diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md new file mode 100644 index 00000000..9c301e93 --- /dev/null +++ b/docs/ccommon_api.md @@ -0,0 +1,26 @@ +# Module [ccommon](../stc/ccommon.h): Common methods and definitions + +This describes the features the ccommon.h header file. + +## Macros + +#### c_new, c_del + +#### c_malloc, c_calloc, c_realloc, c_free + +#### c_foreach + +#### c_forrange + +#### c_withbuffer + +#### c_withfile + +#### c_push_items + +#### c_swap + +## Example + +```c +``` diff --git a/docs/cmap_api.md b/docs/cmap_api.md index 6e1b7af4..24c82dc0 100644 --- a/docs/cmap_api.md +++ b/docs/cmap_api.md @@ -84,6 +84,7 @@ cmap_X cmap_X_init(void); cmap_X cmap_X_with_capacity(size_t cap); void cmap_X_set_load_factors(cmap_X* self, float max, float shrink); +cmap_X cmap_X_clone(cmap_x map); void cmap_X_clear(cmap_X* self); void cmap_X_reserve(cmap_X* self, size_t size); void cmap_X_swap(cmap_X* a, cmap_X* b); diff --git a/docs/containers-small.jpg b/docs/containers-small.jpg deleted file mode 100644 index cc56a141..00000000 Binary files a/docs/containers-small.jpg and /dev/null differ diff --git a/docs/containers.jpg b/docs/containers.jpg new file mode 100644 index 00000000..cc56a141 Binary files /dev/null and b/docs/containers.jpg differ diff --git a/docs/cset_api.md b/docs/cset_api.md index 412ff572..2c2f8b22 100644 --- a/docs/cset_api.md +++ b/docs/cset_api.md @@ -54,6 +54,7 @@ cset_X cset_X_init(void); cset_X cset_X_with_capacity(size_t cap); void cset_X_set_load_factors(cset_X* self, float max, float shrink); +cset_X cset_X_clone(cset_x set); void cset_X_clear(cset_X* self); void cset_X_reserve(cset_X* self, size_t size); void cset_X_swap(cset_X* a, cset_X* b); -- cgit v1.2.3