diff options
| author | Tyge Løvset <[email protected]> | 2021-12-29 15:14:37 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-12-29 15:14:37 +0100 |
| commit | a53b2f4269951e0b5340723670137b4fdf96534c (patch) | |
| tree | e5d36c28d0fd548873216426bb00a6b59d2730dd /docs/cqueue_api.md | |
| parent | 183a89859ba9914ee0546e4482b40be199e52292 (diff) | |
| parent | 92f5421493932d00e63b33152331a36cc4fc9491 (diff) | |
| download | STC-modified-a53b2f4269951e0b5340723670137b4fdf96534c.tar.gz STC-modified-a53b2f4269951e0b5340723670137b4fdf96534c.zip | |
Merge pull request #17 from tylov/version3
Version3
Breaking changes are covered by the migration guide in the NEWS section in README.md
Diffstat (limited to 'docs/cqueue_api.md')
| -rw-r--r-- | docs/cqueue_api.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md index 469b7c99..0ecae014 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -9,7 +9,7 @@ See the c++ class [std::queue](https://en.cppreference.com/w/cpp/container/queue ```c #define i_val // value: REQUIRED #define i_cmp // three-way compare two i_valraw* : REQUIRED IF i_valraw is a non-integral type -#define i_del // destroy value func - defaults to empty destruct +#define i_drop // destroy value func - defaults to empty destruct #define i_valraw // convertion "raw" type - defaults to i_val #define i_valfrom // convertion func i_valraw => i_val - defaults to plain copy #define i_valto // convertion func i_val* => i_valraw - defaults to plain copy @@ -27,7 +27,7 @@ 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_drop(cqueue_X* self); // destructor size_t cqueue_X_size(cqueue_X q); bool cqueue_X_empty(cqueue_X q); @@ -52,7 +52,7 @@ i_val cqueue_X_value_clone(i_val value); |:--------------------|:---------------------|:-------------------------| | `cqueue_X` | `cdeq_X` | The cqueue type | | `cqueue_X_value` | `i_val` | The cqueue element type | -| `cqueue_X_rawvalue` | `i_valraw` | cqueue raw value type | +| `cqueue_X_raw` | `i_valraw` | cqueue raw value type | | `cqueue_X_iter` | `cdeq_X_iter` | cqueue iterator | ## Examples @@ -76,7 +76,7 @@ int main() { c_foreach (i, cqueue_i, Q) printf(" %d", *i.ref); - cqueue_i_del(&Q); + cqueue_i_drop(&Q); } ``` Output: |