summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorTyge Løvset <[email protected]>2020-11-24 20:52:10 +0100
committerGitHub <[email protected]>2020-11-24 20:52:10 +0100
commit9285c481dfbda67874765f06a54fc1ffb23f15aa (patch)
treed7dc198a7b3030bfe90e9a3ee5ede8188452a06f /docs
parent39af022081d864736d5295770c4da1f75f5176ef (diff)
downloadSTC-modified-9285c481dfbda67874765f06a54fc1ffb23f15aa.tar.gz
STC-modified-9285c481dfbda67874765f06a54fc1ffb23f15aa.zip
Update cstr_api.md
Diffstat (limited to 'docs')
-rw-r--r--docs/cstr_api.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/cstr_api.md b/docs/cstr_api.md
index 6ab29678..f804e1ff 100644
--- a/docs/cstr_api.md
+++ b/docs/cstr_api.md
@@ -1,6 +1,6 @@
# Introduction
-This describes the API of the **cstr_t** API
+This describes the API of **cstr_t**.
## Types
@@ -87,18 +87,24 @@ void cstr_replace_n( cstr_t* self, size_t pos, size_t len, const char* s
```
```c
+size_t cstr_find( cstr_t s, const char* needle );
+size_t cstr_find_n( cstr_t s, const char* needle, size_t pos, size_t nlen );
+```
+
+```c
bool cstr_equals( cstr_t s1, const char* str );
bool cstr_equals_caseins( cstr_t s1, const char* str );
bool cstr_equals_s( cstr_t s1, cstr_t s2 );
int cstr_compare( const cstr_t *s1, const cstr_t *s2 );
int cstr_casecmp( const cstr_t *s1, const cstr_t *s2 );
-size_t cstr_find( cstr_t s, const char* needle );
-size_t cstr_find_n( cstr_t s, const char* needle, size_t pos, size_t nlen );
```
```c
char* cstr_front( cstr_t* self );
char* cstr_back( cstr_t* self );
+```
+
+```c
cstr_iter_t cstr_begin( cstr_t* self );
cstr_iter_t cstr_end( cstr_t* self );
void cstr_next(cstr_iter_t* it) { ++it->val; }