Moved docstrings to API.md

This commit is contained in:
Sergey Lyubka
2013-10-19 13:14:16 -07:00
parent ddea940690
commit f852a4db0f
2 changed files with 18 additions and 14 deletions
+18
View File
@@ -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
-14
View File
@@ -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);