summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2022-06-01 19:03:49 +0200
committerTyge Løvset <[email protected]>2022-06-01 19:03:49 +0200
commit14b85f80eddd835f2fb9c5925cd8728264fc73cf (patch)
treeca21a18f424b957f4970dca8c313e850713791e5 /docs
parent254e61e2774d6b8fa6064e61c054014bfc460d91 (diff)
downloadSTC-modified-14b85f80eddd835f2fb9c5925cd8728264fc73cf.tar.gz
STC-modified-14b85f80eddd835f2fb9c5925cd8728264fc73cf.zip
Update docs on i_implement / shared linking.
Diffstat (limited to 'docs')
-rw-r--r--docs/cbits_api.md2
-rw-r--r--docs/ccommon_api.md1
-rw-r--r--docs/cmap_api.md4
-rw-r--r--docs/crandom_api.md1
-rw-r--r--docs/csmap_api.md2
-rw-r--r--docs/csset_api.md1
-rw-r--r--docs/cstr_api.md1
-rw-r--r--docs/csview_api.md5
-rw-r--r--docs/cvec_api.md2
9 files changed, 1 insertions, 18 deletions
diff --git a/docs/cbits_api.md b/docs/cbits_api.md
index b18526f3..84878e30 100644
--- a/docs/cbits_api.md
+++ b/docs/cbits_api.md
@@ -64,7 +64,7 @@ void cbits_xor(cbits* self, const cbits* other); // set
## Example
```c
-#define i_implement // implementation of cbits_count() only once.
+#define i_implement // force shared implementation of some cbits functionn.
#include <stc/cbits.h>
#include <stdio.h>
#include <math.h>
diff --git a/docs/ccommon_api.md b/docs/ccommon_api.md
index ff44cf12..9d2baea6 100644
--- a/docs/ccommon_api.md
+++ b/docs/ccommon_api.md
@@ -60,7 +60,6 @@ c_autodefer (cstr_drop(&s1), cstr_drop(&s2))
**Example**: Load each line of a text file into a vector of strings:
```c
#include <errno.h>
-#define i_implement
#include <stc/cstr.h>
#define i_val_str
diff --git a/docs/cmap_api.md b/docs/cmap_api.md
index b30353ef..58d33534 100644
--- a/docs/cmap_api.md
+++ b/docs/cmap_api.md
@@ -113,7 +113,6 @@ bool c_memcmp_eq(const i_keyraw* a, const i_keyraw* b); /
## Examples
```c
-#define i_implement
#include <stc/cstr.h>
#define i_key_str
@@ -158,7 +157,6 @@ The HEX of color BLACK is:[#000000]
### Example 2
This example uses a cmap with cstr as mapped value.
```c
-#define i_implement
#include <stc/cstr.h>
#define i_key int
@@ -267,7 +265,6 @@ Output:
### Example 5
Advanced 1: Key type is struct.
```c
-#define i_implement
#include <stc/cstr.h>
typedef struct {
@@ -344,7 +341,6 @@ Advanced 2: In example 5 we needed to construct a lookup key which allocated str
In this example we use rawtype feature to make it even simpler to use. Note that we must use the emplace() methods
to add "raw" type entries (otherwise compile error):
```c
-#define i_implement
#include <stc/cstr.h>
typedef struct Viking {
diff --git a/docs/crandom_api.md b/docs/crandom_api.md
index 3047d116..3e6ae8f0 100644
--- a/docs/crandom_api.md
+++ b/docs/crandom_api.md
@@ -72,7 +72,6 @@ double stc64_normalf(stc64_t* rng, stc64_normalf_t* dist);
```c
#include <time.h>
#include <stc/crandom.h>
-#define i_implement
#include <stc/cstr.h>
// Declare int -> int sorted map. Uses typetag 'i' for ints.
diff --git a/docs/csmap_api.md b/docs/csmap_api.md
index 8e790eff..a797e3cd 100644
--- a/docs/csmap_api.md
+++ b/docs/csmap_api.md
@@ -101,7 +101,6 @@ csmap_X_raw csmap_X_value_toraw(csmap_X_value* pval);
## Examples
```c
-#define i_implement
#include <stc/cstr.h>
#define i_key_str // special macro for i_key = cstr, i_tag = str
@@ -146,7 +145,6 @@ The HEX of color BLACK is:[#000000]
### Example 2
This example uses a csmap with cstr as mapped value.
```c
-#define i_implement
#include <stc/cstr.h>
#define i_key int
diff --git a/docs/csset_api.md b/docs/csset_api.md
index e7a7b044..5106a791 100644
--- a/docs/csset_api.md
+++ b/docs/csset_api.md
@@ -73,7 +73,6 @@ csset_X_value csset_X_value_clone(csset_X_value val);
## Example
```c
-#define i_implement
#include <stc/cstr.h>
#define i_key_str
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 6f851911..989f59df 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -134,7 +134,6 @@ int c_strncasecmp(const char* str1, const char* str2, size_t n);
## Example
```c
-#define i_implement
#include <stc/cstr.h>
int main() {
diff --git a/docs/csview_api.md b/docs/csview_api.md
index c60bec19..e95737b1 100644
--- a/docs/csview_api.md
+++ b/docs/csview_api.md
@@ -21,8 +21,6 @@ All csview definitions and prototypes are available by including a single header
```c
#include <stc/cstr.h> // optional, include cstr+csview functionality
-
-#define i_implement // define in one file only if needed
#include <stc/csview.h>
```
## Methods
@@ -125,7 +123,6 @@ uint64_t csview_hash(const csview* x);
## Example
```c
-#define i_implement
#include <stc/cstr.h>
#include <stc/csview.h>
@@ -156,7 +153,6 @@ red Apples
### Example 2: UTF8 handling
```c
-#define i_implement
#include <stc/cstr.h>
#include <stc/csview.h>
@@ -195,7 +191,6 @@ void print_split(csview str, csview sep)
}
}
-#define i_implement
#include <stc/cstr.h>
#define i_val_str
diff --git a/docs/cvec_api.md b/docs/cvec_api.md
index f1225d72..2ea52e56 100644
--- a/docs/cvec_api.md
+++ b/docs/cvec_api.md
@@ -147,7 +147,6 @@ sorted: 5 7 8 13 16 25
```
### Example 2
```c
-#define i_implement
#include <stc/cstr.h>
#define i_val_str
@@ -182,7 +181,6 @@ item: 2 elements so far
Container with elements of structs:
```c
-#define i_implement
#include <stc/cstr.h>
typedef struct {