Commit be63c0dc authored by Dmitry Frank's avatar Dmitry Frank Committed by Cesanta Bot

Improve docs

PUBLISHED_FROM=3b75fd8247ba9028e0ef0c3e211e7c1a80013951
parent 987bc1d5
...@@ -1862,10 +1862,14 @@ struct mg_str { ...@@ -1862,10 +1862,14 @@ struct mg_str {
}; };
/* /*
* Helper functions for creating mg_str struct from plain C string. * Helper function for creating mg_str struct from plain C string.
* `NULL` is allowed and becomes `{NULL, 0}`. * `NULL` is allowed and becomes `{NULL, 0}`.
*/ */
struct mg_str mg_mk_str(const char *s); struct mg_str mg_mk_str(const char *s);
/*
* Like `mg_mk_str`, but takes string length explicitly.
*/
struct mg_str mg_mk_str_n(const char *s, size_t len); struct mg_str mg_mk_str_n(const char *s, size_t len);
/* Macro for initializing mg_str. */ /* Macro for initializing mg_str. */
...@@ -1900,9 +1904,19 @@ struct mg_str mg_strdup_nul(const struct mg_str s); ...@@ -1900,9 +1904,19 @@ struct mg_str mg_strdup_nul(const struct mg_str s);
*/ */
const char *mg_strchr(const struct mg_str s, int c); const char *mg_strchr(const struct mg_str s, int c);
/*
* Compare two `mg_str`s; return value is the same as `strcmp`.
*/
int mg_strcmp(const struct mg_str str1, const struct mg_str str2); int mg_strcmp(const struct mg_str str1, const struct mg_str str2);
/*
* Like `mg_strcmp`, but compares at most `n` characters.
*/
int mg_strncmp(const struct mg_str str1, const struct mg_str str2, size_t n); int mg_strncmp(const struct mg_str str1, const struct mg_str str2, size_t n);
/*
* Finds the first occurrence of a substring `needle` in the `haystack`.
*/
const char *mg_strstr(const struct mg_str haystack, const struct mg_str needle); const char *mg_strstr(const struct mg_str haystack, const struct mg_str needle);
#ifdef __cplusplus #ifdef __cplusplus
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment