summaryrefslogtreecommitdiffstats
path: root/include/zix/strindex.h
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-07-01 00:05:22 -0400
committerDavid Robillard <d@drobilla.net>2021-07-17 19:58:17 -0400
commit4b266e2f39a8d3a49b58c861c7fd852911cf7fb0 (patch)
treedc12d618dc52b640b82e522917b238e38af033b3 /include/zix/strindex.h
parent46f9327b06e866e3180c1924a0afa0afd8b0b5c5 (diff)
downloadzix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.gz
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.tar.bz2
zix-4b266e2f39a8d3a49b58c861c7fd852911cf7fb0.zip
Use line comments where appropriate
Diffstat (limited to 'include/zix/strindex.h')
-rw-r--r--include/zix/strindex.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/zix/strindex.h b/include/zix/strindex.h
index f596079..8493b8c 100644
--- a/include/zix/strindex.h
+++ b/include/zix/strindex.h
@@ -30,21 +30,21 @@ typedef struct ZixStrindexImpl ZixStrindex;
/**
Construct a new strindex that contains all suffixes of the string `s`.
+
A copy of `s` is taken and stored for the lifetime of the strindex.
*/
ZIX_API
ZixStrindex*
zix_strindex_new(const char* s);
-/**
- Destroy `t`.
-*/
+/// Destroy `t`
ZIX_API
void
zix_strindex_free(ZixStrindex* strindex);
/**
Check if the string in `strindex` contains the substring `str`.
+
If such a substring is found, `match` is pointed at an occurrence of it.
*/
ZIX_API