mirror of
https://github.com/cesanta/mongoose.git
synced 2026-11-09 16:21:45 +00:00
Fix mongoose docs generation
PUBLISHED_FROM=331821dcd1f7dc8a94581cd8a9b51aa00a89fddc
This commit is contained in:
1 parent
ab000c684a
commit
3eb4eb8074
166 files changed
+3125
No files matched your search
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "URI"
|
||||
symbol_kind: "intro"
|
||||
decl_name: "mg_uri.h"
|
||||
items:
|
||||
- { name: mg_assemble_uri.md }
|
||||
- { name: mg_parse_uri.md }
|
||||
---
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: "mg_assemble_uri()"
|
||||
decl_name: "mg_assemble_uri"
|
||||
symbol_kind: "func"
|
||||
signature: |
|
||||
int mg_assemble_uri(const struct mg_str *scheme, const struct mg_str *user_info,
|
||||
const struct mg_str *host, unsigned int port,
|
||||
const struct mg_str *path, const struct mg_str *query,
|
||||
const struct mg_str *fragment, int normalize_path,
|
||||
struct mg_str *uri);
|
||||
---
|
||||
|
||||
Assemble URI from parts. Any of the inputs can be NULL or zero-length mg_str.
|
||||
|
||||
If normalize_path is true, path is normalized by resolving relative refs.
|
||||
|
||||
Result is a heap-allocated string (uri->p must be free()d after use).
|
||||
|
||||
Returns 0 on success, -1 on error.
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
title: "mg_parse_uri()"
|
||||
decl_name: "mg_parse_uri"
|
||||
symbol_kind: "func"
|
||||
signature: |
|
||||
int mg_parse_uri(const struct mg_str uri, struct mg_str *scheme,
|
||||
struct mg_str *user_info, struct mg_str *host,
|
||||
unsigned int *port, struct mg_str *path, struct mg_str *query,
|
||||
struct mg_str *fragment);
|
||||
---
|
||||
|
||||
Parses an URI and fills string chunks with locations of the respective
|
||||
uri components within the input uri string. NULL pointers will be
|
||||
ignored.
|
||||
|
||||
General syntax:
|
||||
|
||||
[scheme://[user_info@]]host[:port][/path][?query][#fragment]
|
||||
|
||||
Example:
|
||||
|
||||
foo.com:80
|
||||
tcp://foo.com:1234
|
||||
http://foo.com:80/bar?baz=1
|
||||
https://user:pw@foo.com:443/blah
|
||||
|
||||
`path` will include the leading slash. `query` won't include the leading `?`.
|
||||
`host` can contain embedded colons if surrounded by square brackets in order
|
||||
to support IPv6 literal addresses.
|
||||
|
||||
|
||||
Returns 0 on success, -1 on error.
|
||||
|
||||
Reference in new issue
Block a user