summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-10-06 16:08:08 +0200
committerTyge Løvset <[email protected]>2021-10-06 16:08:08 +0200
commit435fd25e5c74aea72eb20f4007977183cdbe0919 (patch)
tree58606c15052b37d27858ea6f707df8b2edf34a49 /docs
parent0fa5220d8d7cddbb668d02045ebd36709ba0bc6f (diff)
downloadSTC-modified-435fd25e5c74aea72eb20f4007977183cdbe0919.tar.gz
STC-modified-435fd25e5c74aea72eb20f4007977183cdbe0919.zip
Some while to for changed. Return value for cstack_X_push/emplace. Docs updated.
Diffstat (limited to 'docs')
-rw-r--r--docs/cdeq_api.md8
-rw-r--r--docs/cqueue_api.md44
-rw-r--r--docs/cstack_api.md36
-rw-r--r--docs/cvec_api.md4
4 files changed, 46 insertions, 46 deletions
diff --git a/docs/cdeq_api.md b/docs/cdeq_api.md
index 26a6bbff..90a44293 100644
--- a/docs/cdeq_api.md
+++ b/docs/cdeq_api.md
@@ -42,12 +42,12 @@ cdeq_X_value_t* cdeq_X_at(const cdeq_X* self, size_t idx);
cdeq_X_value_t* cdeq_X_front(const cdeq_X* self);
cdeq_X_value_t* cdeq_X_back(const cdeq_X* self);
-void cdeq_X_push_front(cdeq_X* self, i_val value);
-void cdeq_X_emplace_front(cdeq_X* self, i_valraw raw);
+cdeq_X_value_t* cdeq_X_push_front(cdeq_X* self, i_val value);
+cdeq_X_value_t* cdeq_X_emplace_front(cdeq_X* self, i_valraw raw);
void cdeq_X_pop_front(cdeq_X* self);
-void cdeq_X_push_back(cdeq_X* self, i_val value);
-void cdeq_X_emplace_back(cdeq_X* self, i_valraw raw);
+cdeq_X_value_t* cdeq_X_push_back(cdeq_X* self, i_val value);
+cdeq_X_value_t* cdeq_X_emplace_back(cdeq_X* self, i_valraw raw);
void cdeq_X_pop_back(cdeq_X* self);
cdeq_X_iter_t cdeq_X_insert(cdeq_X* self, size_t idx, i_val value); // move value
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md
index 76c189e5..087f9da5 100644
--- a/docs/cqueue_api.md
+++ b/docs/cqueue_api.md
@@ -22,38 +22,38 @@ See the c++ class [std::queue](https://en.cppreference.com/w/cpp/container/queue
## Methods
```c
-cqueue_X cqueue_X_init(void);
-cqueue_X cqueue_X_clone(cqueue_X q);
+cqueue_X cqueue_X_init(void);
+cqueue_X cqueue_X_clone(cqueue_X q);
-void cqueue_X_clear(cqueue_X* self);
-void cqueue_X_copy(cqueue_X* self, cqueue_X other);
-void cqueue_X_del(cqueue_X* self); // destructor
+void cqueue_X_clear(cqueue_X* self);
+void cqueue_X_copy(cqueue_X* self, cqueue_X other);
+void cqueue_X_del(cqueue_X* self); // destructor
-size_t cqueue_X_size(cqueue_X q);
-bool cqueue_X_empty(cqueue_X q);
-cqueue_X_value_t* cqueue_X_front(const cqueue_X* self);
-cqueue_X_value_t* cqueue_X_back(const cqueue_X* self);
+size_t cqueue_X_size(cqueue_X q);
+bool cqueue_X_empty(cqueue_X q);
+cqueue_X_value_t* cqueue_X_front(const cqueue_X* self);
+cqueue_X_value_t* cqueue_X_back(const cqueue_X* self);
-void cqueue_X_push(cqueue_X* self, cqueue_X_value_t value);
-void cqueue_X_emplace(cqueue_X* self, cqueue_X_rawvalue_t raw);
+cqueue_X_value_t* cqueue_X_push(cqueue_X* self, i_val value);
+cqueue_X_value_t* cqueue_X_emplace(cqueue_X* self, i_valraw raw);
-void cqueue_X_pop(cqueue_X* self);
+void cqueue_X_pop(cqueue_X* self);
-cqueue_X_iter_t cqueue_X_begin(const cqueue_X* self);
-cqueue_X_iter_t cqueue_X_end(const cqueue_X* self);
-void cqueue_X_next(cqueue_X_iter_t* it);
+cqueue_X_iter_t cqueue_X_begin(const cqueue_X* self);
+cqueue_X_iter_t cqueue_X_end(const cqueue_X* self);
+void cqueue_X_next(cqueue_X_iter_t* it);
-cqueue_X_value_t cqueue_X_value_clone(cqueue_X_value_t val);
+i_val cqueue_X_value_clone(i_val value);
```
## Types
-| Type name | Type definition | Used to represent... |
-|:----------------------|:---------------------------------------|:-------------------------|
-| `cqueue_X` | Same as `cdeq_X` type | The cqueue type |
-| `cqueue_X_value_t` | " | The cqueue element type |
-| `cqueue_X_rawvalue_t` | " | cqueue raw value type |
-| `cqueue_X_iter_t` | " | cqueue iterator |
+| Type name | Type definition | Used to represent... |
+|:----------------------|:---------------------|:-------------------------|
+| `cqueue_X` | `cdeq_X` | The cqueue type |
+| `cqueue_X_value_t` | `i_val` | The cqueue element type |
+| `cqueue_X_rawvalue_t` | `i_valraw` | cqueue raw value type |
+| `cqueue_X_iter_t` | `cdeq_X_iter_t` | cqueue iterator |
## Examples
```c
diff --git a/docs/cstack_api.md b/docs/cstack_api.md
index 31f6ade7..5b878ba4 100644
--- a/docs/cstack_api.md
+++ b/docs/cstack_api.md
@@ -22,30 +22,30 @@ See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack
## Methods
```c
-cstack_X cstack_X_init(void);
-cstack_X cstack_X_clone(cstack_X st);
+cstack_X cstack_X_init(void);
+cstack_X cstack_X_clone(cstack_X st);
-void cstack_X_clear(cstack_X* self);
-void cstack_X_reserve(cstack_X* self, size_t n);
-void cstack_X_shrink_to_fit(cstack_X* self);
-void cstack_X_copy(cstack_X* self, cstack_X other);
-void cstack_X_del(cstack_X* self); // destructor
+void cstack_X_clear(cstack_X* self);
+void cstack_X_reserve(cstack_X* self, size_t n);
+void cstack_X_shrink_to_fit(cstack_X* self);
+void cstack_X_copy(cstack_X* self, cstack_X other);
+void cstack_X_del(cstack_X* self); // destructor
-size_t cstack_X_size(cstack_X st);
-bool cstack_X_empty(cstack_X st);
-cstack_X_value_t* cstack_X_top(const cstack_X* self);
+size_t cstack_X_size(cstack_X st);
+bool cstack_X_empty(cstack_X st);
+cstack_X_value_t* cstack_X_top(const cstack_X* self);
-void cstack_X_push(cstack_X* self, cstack_X_value_t value);
-void cstack_X_emplace(cstack_X* self, cstack_X_rawvalue_t raw);
+cstack_X_value_t* cstack_X_push(cstack_X* self, i_val value);
+cstack_X_value_t* cstack_X_emplace(cstack_X* self, i_valraw raw);
-void cstack_X_pop(cstack_X* self);
+void cstack_X_pop(cstack_X* self);
-cstack_X_iter_t cstack_X_begin(const cstack_X* self);
-cstack_X_iter_t cstack_X_end(const cstack_X* self);
-void cstack_X_next(cstack_X_iter_t* it);
+cstack_X_iter_t cstack_X_begin(const cstack_X* self);
+cstack_X_iter_t cstack_X_end(const cstack_X* self);
+void cstack_X_next(cstack_X_iter_t* it);
-cstack_X_rawvalue_t cstack_X_value_toraw(cvec_X_value_t* pval);
-cstack_X_value_t cstack_X_value_clone(cstack_X_value_t val);
+i_valraw cstack_X_value_toraw(cvec_X_value_t* pval);
+i_val cstack_X_value_clone(i_val value);
```
## Types
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index 549bce2a..3a78bf58 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -49,8 +49,8 @@ cvec_X_value_t* cvec_X_at(const cvec_X* self, size_t idx);
cvec_X_value_t* cvec_X_front(const cvec_X* self);
cvec_X_value_t* cvec_X_back(const cvec_X* self);
-void cvec_X_push_back(cvec_X* self, i_val value);
-void cvec_X_emplace_back(cvec_X* self, i_valraw raw);
+cvec_X_value_t* cvec_X_push_back(cvec_X* self, i_val value);
+cvec_X_value_t* cvec_X_emplace_back(cvec_X* self, i_valraw raw);
void cvec_X_pop_back(cvec_X* self);
cvec_X_iter_t cvec_X_insert(cvec_X* self, size_t idx, i_val value); // move value