Fix mongoose docs generation

PUBLISHED_FROM=331821dcd1f7dc8a94581cd8a9b51aa00a89fddc
This commit is contained in:
Dmitry Frank committed 2018-02-03 01:20:48 +02:00
1 parent ab000c684a
commit 3eb4eb8074
166 files changed
+3125

No files matched your search

+29
View File
@@ -0,0 +1,29 @@
---
title: "MQTT API reference"
symbol_kind: "intro"
decl_name: "mg_mqtt.h"
items:
- { name: mg_mqtt_connack.md }
- { name: mg_mqtt_disconnect.md }
- { name: mg_mqtt_match_topic_expression.md }
- { name: mg_mqtt_next_subscribe_topic.md }
- { name: mg_mqtt_ping.md }
- { name: mg_mqtt_pong.md }
- { name: mg_mqtt_puback.md }
- { name: mg_mqtt_pubcomp.md }
- { name: mg_mqtt_publish.md }
- { name: mg_mqtt_pubrec.md }
- { name: mg_mqtt_pubrel.md }
- { name: mg_mqtt_suback.md }
- { name: mg_mqtt_subscribe.md }
- { name: mg_mqtt_unsuback.md }
- { name: mg_mqtt_unsubscribe.md }
- { name: mg_mqtt_vmatch_topic_expression.md }
- { name: mg_send_mqtt_handshake.md }
- { name: mg_send_mqtt_handshake_opt.md }
- { name: mg_set_protocol_mqtt.md }
- { name: struct_mg_mqtt_proto_data.md }
---
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_connack()"
decl_name: "mg_mqtt_connack"
symbol_kind: "func"
signature: |
void mg_mqtt_connack(struct mg_connection *nc, uint8_t return_code);
---
Sends a CONNACK command with a given `return_code`.
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_disconnect()"
decl_name: "mg_mqtt_disconnect"
symbol_kind: "func"
signature: |
void mg_mqtt_disconnect(struct mg_connection *nc);
---
Sends a DISCONNECT command.
@@ -0,0 +1,12 @@
---
title: "mg_mqtt_match_topic_expression()"
decl_name: "mg_mqtt_match_topic_expression"
symbol_kind: "func"
signature: |
int mg_mqtt_match_topic_expression(struct mg_str exp, struct mg_str topic);
---
Matches a topic against a topic expression
Returns 1 if it matches; 0 otherwise.
@@ -0,0 +1,15 @@
---
title: "mg_mqtt_next_subscribe_topic()"
decl_name: "mg_mqtt_next_subscribe_topic"
symbol_kind: "func"
signature: |
int mg_mqtt_next_subscribe_topic(struct mg_mqtt_message *msg,
struct mg_str *topic, uint8_t *qos, int pos);
---
Extracts the next topic expression from a SUBSCRIBE command payload.
The topic expression name will point to a string in the payload buffer.
Returns the pos of the next topic expression or -1 when the list
of topics is exhausted.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_ping()"
decl_name: "mg_mqtt_ping"
symbol_kind: "func"
signature: |
void mg_mqtt_ping(struct mg_connection *nc);
---
Sends a PINGREQ command.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_pong()"
decl_name: "mg_mqtt_pong"
symbol_kind: "func"
signature: |
void mg_mqtt_pong(struct mg_connection *nc);
---
Sends a PINGRESP command.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_puback()"
decl_name: "mg_mqtt_puback"
symbol_kind: "func"
signature: |
void mg_mqtt_puback(struct mg_connection *nc, uint16_t message_id);
---
Sends a PUBACK command with a given `message_id`.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_pubcomp()"
decl_name: "mg_mqtt_pubcomp"
symbol_kind: "func"
signature: |
void mg_mqtt_pubcomp(struct mg_connection *nc, uint16_t message_id);
---
Sends a PUBCOMP command with a given `message_id`.
+12
View File
@@ -0,0 +1,12 @@
---
title: "mg_mqtt_publish()"
decl_name: "mg_mqtt_publish"
symbol_kind: "func"
signature: |
void mg_mqtt_publish(struct mg_connection *nc, const char *topic,
uint16_t message_id, int flags, const void *data,
size_t len);
---
Publishes a message to a given topic.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_pubrec()"
decl_name: "mg_mqtt_pubrec"
symbol_kind: "func"
signature: |
void mg_mqtt_pubrec(struct mg_connection *nc, uint16_t message_id);
---
Sends a PUBREC command with a given `message_id`.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_pubrel()"
decl_name: "mg_mqtt_pubrel"
symbol_kind: "func"
signature: |
void mg_mqtt_pubrel(struct mg_connection *nc, uint16_t message_id);
---
Sends a PUBREL command with a given `message_id`.
+12
View File
@@ -0,0 +1,12 @@
---
title: "mg_mqtt_suback()"
decl_name: "mg_mqtt_suback"
symbol_kind: "func"
signature: |
void mg_mqtt_suback(struct mg_connection *nc, uint8_t *qoss, size_t qoss_len,
uint16_t message_id);
---
Sends a SUBACK command with a given `message_id`
and a sequence of granted QoSs.
+12
View File
@@ -0,0 +1,12 @@
---
title: "mg_mqtt_subscribe()"
decl_name: "mg_mqtt_subscribe"
symbol_kind: "func"
signature: |
void mg_mqtt_subscribe(struct mg_connection *nc,
const struct mg_mqtt_topic_expression *topics,
size_t topics_len, uint16_t message_id);
---
Subscribes to a bunch of topics.
+10
View File
@@ -0,0 +1,10 @@
---
title: "mg_mqtt_unsuback()"
decl_name: "mg_mqtt_unsuback"
symbol_kind: "func"
signature: |
void mg_mqtt_unsuback(struct mg_connection *nc, uint16_t message_id);
---
Sends a UNSUBACK command with a given `message_id`.
@@ -0,0 +1,11 @@
---
title: "mg_mqtt_unsubscribe()"
decl_name: "mg_mqtt_unsubscribe"
symbol_kind: "func"
signature: |
void mg_mqtt_unsubscribe(struct mg_connection *nc, char **topics,
size_t topics_len, uint16_t message_id);
---
Unsubscribes from a bunch of topics.
@@ -0,0 +1,11 @@
---
title: "mg_mqtt_vmatch_topic_expression()"
decl_name: "mg_mqtt_vmatch_topic_expression"
symbol_kind: "func"
signature: |
int mg_mqtt_vmatch_topic_expression(const char *exp, struct mg_str topic);
---
Same as `mg_mqtt_match_topic_expression()`, but takes `exp` as a
NULL-terminated string.
@@ -0,0 +1,10 @@
---
title: "mg_send_mqtt_handshake()"
decl_name: "mg_send_mqtt_handshake"
symbol_kind: "func"
signature: |
void mg_send_mqtt_handshake(struct mg_connection *nc, const char *client_id);
---
Sends an MQTT handshake.
@@ -0,0 +1,11 @@
---
title: "mg_send_mqtt_handshake_opt()"
decl_name: "mg_send_mqtt_handshake_opt"
symbol_kind: "func"
signature: |
void mg_send_mqtt_handshake_opt(struct mg_connection *nc, const char *client_id,
struct mg_send_mqtt_handshake_opts);
---
Sends an MQTT handshake with optional parameters.
@@ -0,0 +1,20 @@
---
title: "mg_set_protocol_mqtt()"
decl_name: "mg_set_protocol_mqtt"
symbol_kind: "func"
signature: |
void mg_set_protocol_mqtt(struct mg_connection *nc);
---
Attaches a built-in MQTT event handler to the given connection.
The user-defined event handler will receive following extra events:
- MG_EV_MQTT_CONNACK
- MG_EV_MQTT_PUBLISH
- MG_EV_MQTT_PUBACK
- MG_EV_MQTT_PUBREC
- MG_EV_MQTT_PUBREL
- MG_EV_MQTT_PUBCOMP
- MG_EV_MQTT_SUBACK
@@ -0,0 +1,13 @@
---
title: "struct mg_mqtt_proto_data"
decl_name: "struct mg_mqtt_proto_data"
symbol_kind: "struct"
signature: |
struct mg_mqtt_proto_data {
uint16_t keep_alive;
double last_control_time;
};
---
mg_mqtt_proto_data should be in header to allow external access to it