summaryrefslogtreecommitdiffhomepage
path: root/docs/cmap_api.md
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2021-03-24 14:29:44 +0100
committerTyge Løvset <[email protected]>2021-03-24 14:29:44 +0100
commitb1b19bc2e5a2732e59583184bfa18a34052d5ae1 (patch)
treee800bc0645b4de5b2116c223e99aa23fd79e66ce /docs/cmap_api.md
parentc96dc0a43037dd14cd0e2539c988a343d99cc728 (diff)
downloadSTC-modified-b1b19bc2e5a2732e59583184bfa18a34052d5ae1.tar.gz
STC-modified-b1b19bc2e5a2732e59583184bfa18a34052d5ae1.zip
Cleanup in documentation.
Diffstat (limited to 'docs/cmap_api.md')
-rw-r--r--docs/cmap_api.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index 952ae772..7fccbc46 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -110,9 +110,8 @@ void c_trivial_del(Type* val); // doe
## Examples
```c
-#include <stdio.h>
-#include "stc/cstr.h"
-#include "stc/cmap.h"
+#include <stc/cmap.h>
+#include <stc/cstr.h>
using_cmap_str();
@@ -154,8 +153,8 @@ The HEX of color BLACK is:[#000000]
### Example 2
This example uses a cmap with cstr as mapped value, by the `using_cmap_strval(id, int)` macro.
```c
-#include "stc/cstr.h"
-#include "stc/cmap.h"
+#include <stc/cmap.h>
+#include <stc/cstr.h>
/* cmap<int, cstr>: */
using_cmap_strval(id, int);
@@ -190,7 +189,7 @@ Output:
### Example 3
Demonstrate cmap with plain-old-data key type Vec3i and int as mapped type: cmap<Vec3i, int>.
```c
-#include "stc/cmap.h"
+#include <stc/cmap.h>
#include <stdio.h>
typedef struct { int x, y, z; } Vec3i;
@@ -224,7 +223,7 @@ Output:
### Example 4
Inverse: demonstrate cmap with mapped POD type Vec3i: cmap<int, Vec3i>:
```c
-#include "stc/cmap.h"
+#include <stc/cmap.h>
#include <stdio.h>
typedef struct { int x, y, z; } Vec3i;
@@ -255,7 +254,6 @@ Output:
### Example 5
Advanced, rare usage: Complex key type.
```c
-#include <stdio.h>
#include <stc/cmap.h>
#include <stc/cstr.h>