Apply Mongoose docs edits by Ev

PUBLISHED_FROM=5cd78790a03580aa23dd3d2d8b825ad449083cc2
2026-11-09 16:21:45 +00:00 · 2016-07-26 15:06:04 +00:00
1 parent 4f210cd8eb
commit 849ec1684a
@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_connack(struct mg_connection *nc, uint8_t return_code);
 ---

-Send a CONNACK command with a given `return_code`. 
+Sends a CONNACK command with a given `return_code`. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_disconnect(struct mg_connection *nc);
 ---

-Send a DISCONNECT command. 
+Sends a DISCONNECT command. 

@@ -7,9 +7,9 @@ signature: |
                                   struct mg_str *topic, uint8_t *qos, int pos);
 ---

-Extract the next topic expression from a SUBSCRIBE command payload.
+Extracts the next topic expression from a SUBSCRIBE command payload.

-Topic expression name will point to a string in the payload buffer.
-Return the pos of the next topic expression or -1 when the list
+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. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_ping(struct mg_connection *nc);
 ---

-Send a PINGREQ command. 
+Sends a PINGREQ command. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_pong(struct mg_connection *nc);
 ---

-Send a PINGRESP command. 
+Sends a PINGRESP command. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_puback(struct mg_connection *nc, uint16_t message_id);
 ---

-Send a PUBACK command with a given `message_id`. 
+Sends a PUBACK command with a given `message_id`. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_pubcomp(struct mg_connection *nc, uint16_t message_id);
 ---

-Send a PUBCOMP command with a given `message_id`. 
+Sends a PUBCOMP command with a given `message_id`. 

@@ -8,5 +8,5 @@ signature: |
                       size_t len);
 ---

-Publish a message to a given topic. 
+Publishes a message to a given topic. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_pubrec(struct mg_connection *nc, uint16_t message_id);
 ---

-Send a PUBREC command with a given `message_id`. 
+Sends a PUBREC command with a given `message_id`. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_pubrel(struct mg_connection *nc, uint16_t message_id);
 ---

-Send a PUBREL command with a given `message_id`. 
+Sends a PUBREL command with a given `message_id`. 

@@ -7,6 +7,6 @@ signature: |
                      uint16_t message_id);
 ---

-Send a SUBACK command with a given `message_id`
+Sends a SUBACK command with a given `message_id`
 and a sequence of granted QoSs. 

@@ -8,5 +8,5 @@ signature: |
                         size_t topics_len, uint16_t message_id);
 ---

-Subscribe to a bunch of topics. 
+Subscribes to a bunch of topics. 

@@ -6,5 +6,5 @@ signature: |
  void mg_mqtt_unsuback(struct mg_connection *nc, uint16_t message_id);
 ---

-Send a UNSUBACK command with a given `message_id`. 
+Sends a UNSUBACK command with a given `message_id`. 

@@ -7,5 +7,5 @@ signature: |
                           size_t topics_len, uint16_t message_id);
 ---

-Unsubscribe from a bunch of topics. 
+Unsubscribes from a bunch of topics. 

@@ -6,5 +6,5 @@ signature: |
  void mg_send_mqtt_handshake(struct mg_connection *nc, const char *client_id);
 ---

-Send MQTT handshake. 
+Sends an MQTT handshake. 

@@ -7,5 +7,5 @@ signature: |
                                  struct mg_send_mqtt_handshake_opts);
 ---

-Send MQTT handshake with optional parameters. 
+Sends an MQTT handshake with optional parameters. 

@@ -6,7 +6,7 @@ signature: |
  void mg_set_protocol_mqtt(struct mg_connection *nc);
 ---

-Attach built-in MQTT event handler to the given connection.
+Attaches a built-in MQTT event handler to the given connection.

 The user-defined event handler will receive following extra events: