diff options
Diffstat (limited to 'docs/cstack_api.md')
| -rw-r--r-- | docs/cstack_api.md | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/docs/cstack_api.md b/docs/cstack_api.md index 9d644b5c..85e23455 100644 --- a/docs/cstack_api.md +++ b/docs/cstack_api.md @@ -5,9 +5,11 @@ The **cstack** is a container adapter that gives the programmer the functionalit See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack) for a functional description. -## Declaration +## Header file and declaration ```c +#include <stc/cstack.h> /* includes default underlying implementation header cvec.h */ + using_cstack(X, ctype) ``` The macro `using_cstack()` must be instantiated in the global scope. **cstack** uses normally @@ -15,14 +17,6 @@ a **cvec_X** or **cdeq_X** type as underlying implementation, given as `ctype`. affect the names of all cstack types and methods. E.g. declaring `using_cstack(i, cvec_i);`, `X` should be replaced by `i` in all of the following documentation. -## Header file - -All cstack definitions and prototypes are available by including a single header file. - -```c -#include <stc/cstack.h> /* includes default underlying implementation header cvec.h */ -``` - ## Methods ```c |