From b69006463de7b3f11d974bdddb5782282482f515 Mon Sep 17 00:00:00 2001 From: Tyge Løvset Date: Sun, 6 Nov 2022 12:57:47 +0100 Subject: Improved documentation of template parameters for all containers. --- docs/cstack_api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/cstack_api.md') diff --git a/docs/cstack_api.md b/docs/cstack_api.md index 2a61aecf..e8423385 100644 --- a/docs/cstack_api.md +++ b/docs/cstack_api.md @@ -8,14 +8,16 @@ See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack ## Header file and declaration ```c +#define i_type // full typename of the container #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_valdrop // destroy value func - defaults to empty destruct #define i_valclone // REQUIRED IF i_valdrop defined + #define i_valraw // convertion "raw" type - defaults to i_val #define i_valfrom // convertion func i_valraw => i_val #define i_valto // convertion func i_val* => i_valraw -#define i_tag // defaults to i_val name + +#define i_tag // alternative typename: cstack_{i_tag}. i_tag defaults to i_val #include ``` `X` should be replaced by the value of `i_tag` in all of the following documentation. -- cgit v1.2.3