diff options
| author | Tyge Løvset <[email protected]> | 2021-03-24 15:20:41 +0100 |
|---|---|---|
| committer | Tyge Løvset <[email protected]> | 2021-03-24 15:20:41 +0100 |
| commit | dba28f4d568439545785932ec273a1bc19abee24 (patch) | |
| tree | 9b9d6c27903eb27955a346f0d7b585b639d95896 /docs/cpque_api.md | |
| parent | 52f53e8c8ea9320e2af86d6e1a09f1416a73d51c (diff) | |
| download | STC-modified-dba28f4d568439545785932ec273a1bc19abee24.tar.gz STC-modified-dba28f4d568439545785932ec273a1bc19abee24.zip | |
Removed separate ## Header section in docs.
Diffstat (limited to 'docs/cpque_api.md')
| -rw-r--r-- | docs/cpque_api.md | 12 |
1 files changed, 3 insertions, 9 deletions
diff --git a/docs/cpque_api.md b/docs/cpque_api.md index 44f35b22..e2439c56 100644 --- a/docs/cpque_api.md +++ b/docs/cpque_api.md @@ -5,9 +5,11 @@ A user-provided argument `<`or `>` must be supplied to set the ordering, e.g. us See the c++ class [std::priority_queue](https://en.cppreference.com/w/cpp/container/priority_queue) for a functional reference. -## Declaration +## Header file and declaration ```c +#include <stc/cpque.h> + using_cpque(X, ctype, direction) ``` The macro `using_cpque()` must be instantiated in the global scope. **cpque** uses normally **cvec_X** @@ -18,14 +20,6 @@ Note that the function *`ctype`_value_compare(x, y)* defined by the underlying v compare values (priorities). `X` is a type tag name and will affect the names of all cpque types and methods. Declaring `using_cpque(i, cvec_i, >)`, `X` should be replaced by `i` in the following documentation. -## Header file - -All cpque definitions and prototypes are available by including a single header file. - -```c -#include <stc/cpque.h> -``` - ## Methods ```c |