summaryrefslogtreecommitdiffhomepage
path: root/docs/csmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-24 15:20:41 +0100
committerTyge Løvset <[email protected]>2021-03-24 15:20:41 +0100
commitdba28f4d568439545785932ec273a1bc19abee24 (patch)
tree9b9d6c27903eb27955a346f0d7b585b639d95896 /docs/csmap_api.md
parent52f53e8c8ea9320e2af86d6e1a09f1416a73d51c (diff)
downloadSTC-modified-dba28f4d568439545785932ec273a1bc19abee24.tar.gz
STC-modified-dba28f4d568439545785932ec273a1bc19abee24.zip
Removed separate ## Header section in docs.
Diffstat (limited to 'docs/csmap_api.md')
-rw-r--r--docs/csmap_api.md11
1 files changed, 3 insertions, 8 deletions
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index bf3d3525..bb023c64 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -8,9 +8,11 @@ using the comparison function *keyCompare*. Search, removal, and insertion opera
See the c++ class [std::map](https://en.cppreference.com/w/cpp/container/map) for a functional description.
-## Declaration
+## Header file and declaration
```c
+#include <stc/csmap.h>
+
using_csmap(X, Key, Mapped);
using_csmap(X, Key, Mapped, keyCompare);
using_csmap(X, Key, Mapped, keyCompare, mappedDel, mappedClone);
@@ -35,13 +37,6 @@ The `using_csmap()` macro family must be instantiated in the global scope. `X` i
will affect the names of all csmap types and methods. E.g. declaring `using_csmap(ii, int, int);`, `X` should
be replaced by `ii` in all of the following documentation.
-## Header file
-
-All csmap definitions and prototypes are available by including a single header file.
-
-```c
-#include <stc/csmap.h>
-```
## Methods
```c