From f852a4db0f2da0ce9a35819fa558bb70fbf8576b Mon Sep 17 00:00:00 2001 From: Sergey Lyubka <valenok@gmail.com> Date: Sat, 19 Oct 2013 13:14:16 -0700 Subject: [PATCH] Moved docstrings to API.md --- docs/API.md | 18 ++++++++++++++++++ mongoose.h | 14 -------------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/API.md b/docs/API.md index d4c4eb6d1..e1d4171dd 100644 --- a/docs/API.md +++ b/docs/API.md @@ -129,6 +129,24 @@ initialization. Return value is ignored by Mongoose. Called when Mongoose is about to terminate a thread. Used to clean up the state initialized by `MG_THREAD_BEGIN` handling. Return value is ignored. +## mg\_get\_option() + + const char *mg_get_option(const struct mg_context *ctx, const char *name); + +Get the value of particular configuration parameter. The value returned is +read-only. Mongoose does not allow changing configuration at run time. If +given parameter name is not valid, NULL is returned. For valid names, return +value is guaranteed to be non-NULL. If parameter is not set, zero-length string +is returned. + +## mg\_get\_valid\_option\_names() + + const char **mg_get_valid_option_names(void); + +Return array of strings that represent valid configuration options. For each +option, option name and default value is returned, i.e. the number of entries +in the array equals to number_of_options x 2. Array is NULL terminated. + ## Embedding Examples diff --git a/mongoose.h b/mongoose.h index 36aba6a1d..2e80b2140 100644 --- a/mongoose.h +++ b/mongoose.h @@ -72,21 +72,7 @@ void mg_stop(struct mg_context *); void mg_websocket_handshake(struct mg_connection *); int mg_websocket_read(struct mg_connection *, int *bits, char **data); - - -// Get the value of particular configuration parameter. -// The value returned is read-only. Mongoose does not allow changing -// configuration at run time. -// If given parameter name is not valid, NULL is returned. For valid -// names, return value is guaranteed to be non-NULL. If parameter is not -// set, zero-length string is returned. const char *mg_get_option(const struct mg_context *ctx, const char *name); - - -// Return array of strings that represent valid configuration options. -// For each option, option name and default value is returned, i.e. the -// number of entries in the array equals to number_of_options x 2. -// Array is NULL terminated. const char **mg_get_valid_option_names(void); -- GitLab