diff options
Diffstat (limited to 'docs/cqueue_api.md')
| -rw-r--r-- | docs/cqueue_api.md | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/docs/cqueue_api.md b/docs/cqueue_api.md index b1ce475a..a99f7176 100644 --- a/docs/cqueue_api.md +++ b/docs/cqueue_api.md @@ -5,8 +5,10 @@ The **cqueue** is container adapter that gives the programmer the functionality See the c++ class [std::queue](https://en.cppreference.com/w/cpp/container/queue) for a functional reference. -## Declaration +## Header file and declaration ```c +#include <stc/cqueue.h> /* includes default underlying implementation header cdeq.h */ + using_cqueue(X, ctype) ``` The macro `using_cqueue()` must be instantiated in the global scope. **cqueue** uses normally @@ -14,14 +16,6 @@ a **cdeq_X** or **clist_X** type as underlying implementation, given as `ctype`. `X` is a type tag name and will affect the names of all cqueue types and methods. E.g. declaring `using_cqueue(i, clist_i)`, `X` should be replaced by `i` in all of the following documentation. -## Header file - -All cqueue definitions and prototypes are available by including a single header file. - -```c -#include <stc/cqueue.h> /* includes default underlying implementation header cdeq.h */ -``` - ## Methods ```c |