summaryrefslogtreecommitdiffhomepage
path: root/docs/crawstr_api.md
diff options
context:
space:
mode:
authortylov <[email protected]>2023-08-17 11:40:58 +0200
committertylov <[email protected]>2023-08-17 11:40:58 +0200
commit032bf0a0dfe8b5d368118d4da5862323a021b626 (patch)
treeabed3c05a89dd59d467ce10ecfe181bc240b1483 /docs/crawstr_api.md
parent311f12d7005351ca245aa1df77889d8db4899862 (diff)
downloadSTC-modified-032bf0a0dfe8b5d368118d4da5862323a021b626.tar.gz
STC-modified-032bf0a0dfe8b5d368118d4da5862323a021b626.zip
Corrected/updated string types in docs.
Diffstat (limited to 'docs/crawstr_api.md')
-rw-r--r--docs/crawstr_api.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/crawstr_api.md b/docs/crawstr_api.md
index 7d663a04..b63e532f 100644
--- a/docs/crawstr_api.md
+++ b/docs/crawstr_api.md
@@ -67,11 +67,11 @@ uint32_t utf8_peek_off(const char* s, int offset); // codep
## Types
-| Type name | Type definition | Used to represent... |
-|:----------------|:-------------------------------------------|:-------------------------|
-| `crawstr` | `struct { const char *str; intptr_t size; }` | Raw string view type |
-| `crawstr_value` | `char` | Raw string element type |
-| `crawstr_iter` | `struct { crawstr_value *ref; }` | UTF8 iterator |
+| Type name | Type definition | Used to represent... |
+|:----------------|:---------------------------------------------|:-------------------------|
+| `crawstr` | `struct { const char *str; intptr_t size; }` | The string view type |
+| `crawstr_value` | `const char` | The element type |
+| `crawstr_iter` | `union { crawstr_value *ref; csview chr; }` | UTF8 iterator |
## Example: UTF8 iteration and case conversion
```c