diff options
| author | Tyge Løvset <[email protected]> | 2021-09-21 09:56:57 +0200 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-09-21 09:56:57 +0200 |
| commit | b31765540d40675665d8a58f5fa4d1e23dd5ba64 (patch) | |
| tree | a164d33d40a53a36605362c05ad0f84098a6befb /docs/cstack_api.md | |
| parent | ed62ea868e505d5773d583f4a09c32b13f00c180 (diff) | |
| download | STC-modified-b31765540d40675665d8a58f5fa4d1e23dd5ba64.tar.gz STC-modified-b31765540d40675665d8a58f5fa4d1e23dd5ba64.zip | |
Fixed input args documentation. Fixed carr2 and carr3 clone functions.
Diffstat (limited to 'docs/cstack_api.md')
| -rw-r--r-- | docs/cstack_api.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/cstack_api.md b/docs/cstack_api.md index 8d9abbc5..7cdfe019 100644 --- a/docs/cstack_api.md +++ b/docs/cstack_api.md @@ -1,7 +1,7 @@ # STC [cstack](../include/stc/cstack.h): Stack  -The **cstack** is a container that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The stack pushes and pops the element from the back of the underlying container, known as the top of the stack. +The **cstack** is a container that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The stack pushes and pops the element from the back of the container, known as the top of the stack. See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack) for a functional description. @@ -49,10 +49,10 @@ cstack_X_value_t cstack_X_value_clone(cstack_X_value_t val); | Type name | Type definition | Used to represent... | |:----------------------|:---------------------------------------|:----------------------------| -| `cstack_X` | Depends on underlying container type | The cstack type | -| `cstack_X_value_t` | " | The cstack element type | -| `cstack_X_rawvalue_t` | " | cstack raw value type | -| `cstack_X_iter_t` | " | cstack iterator | +| `cstack_X` | `struct { cstack_value_t *data; ... }` | The cstack type | +| `cstack_X_value_t` | `i_val` | The cstack element type | +| `cstack_X_rawvalue_t` | `i_valraw` | cstack raw value type | +| `cstack_X_iter_t` | `struct { cstack_value_t *ref; }` | cstack iterator | ## Example ```c |