mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2025-02-10 12:39:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Several mqtt documentation fixes found by clang

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-12-29 09:44:07 +01:00
parent 748e2e925b
commit 1466b7ac61
2 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/apps/mqtt/mqtt.c
View File

@ -139,7 +139,8 @@ static const char * const mqtt_message_type_str[15] =
/** /**
* Message type value to string * Message type value to string
* @param msg_type @see mqtt_message_type * @param msg_type see enum mqtt_message_type
*
* @return Control message type text string * @return Control message type text string
*/ */
static const char * static const char *
@ -447,7 +448,7 @@ mqtt_output_append_string(struct mqtt_ringbuf_t *rb, const char *str, u16_t leng
/** /**
* Append fixed header * Append fixed header
* @param rb Output ring buffer * @param rb Output ring buffer
* @param msg_type @see mqtt_message_type * @param msg_type see enum mqtt_message_type
* @param dup MQTT DUP flag * @param dup MQTT DUP flag
* @param qos MQTT QoS field * @param qos MQTT QoS field
* @param retain MQTT retain flag * @param retain MQTT retain flag
@ -613,7 +614,6 @@ pub_ack_rec_rel_response(mqtt_client_t *client, u8_t msg, u16_t pkt_id, u8_t qos
/** /**
* Subscribe response from server * Subscribe response from server
* @param client MQTT client
* @param r Matching request * @param r Matching request
* @param result Result code from server * @param result Result code from server
*/ */
@ -629,7 +629,7 @@ mqtt_incomming_suback(struct mqtt_request_t *r, u8_t result)
/** /**
* Complete MQTT message received or buffer full * Complete MQTT message received or buffer full
* @param client MQTT client * @param client MQTT client
* @param var_hdr_payload Pointer to beginning of variable headers and optional payload * @param fixed_hdr_idx header index
* @param length length received part * @param length length received part
* @param remaining_length Remaining length of complete message * @param remaining_length Remaining length of complete message
*/ */

3
src/include/lwip/apps/mqtt.h
View File

@ -114,7 +114,6 @@ enum {
* Function prototype for MQTT incoming publish data callback function. Called when data * Function prototype for MQTT incoming publish data callback function. Called when data
* arrives to a subscribed topic @see mqtt_subscribe * arrives to a subscribed topic @see mqtt_subscribe
* *
* @param client MQTT client itself
* @param arg Additional argument to pass to the callback function * @param arg Additional argument to pass to the callback function
* @param data User data, pointed object, data may not be referenced after callback return, * @param data User data, pointed object, data may not be referenced after callback return,
NULL is passed when all publish data are delivered NULL is passed when all publish data are delivered
@ -130,11 +129,9 @@ typedef void (*mqtt_incoming_data_cb_t)(void *arg, const u8_t *data, u16_t len,
* Function prototype for MQTT incoming publish function. Called when an incoming publish * Function prototype for MQTT incoming publish function. Called when an incoming publish
* arrives to a subscribed topic @see mqtt_subscribe * arrives to a subscribed topic @see mqtt_subscribe
* *
* @param client MQTT client itself
* @param arg Additional argument to pass to the callback function * @param arg Additional argument to pass to the callback function
* @param topic Zero terminated Topic text string, topic may not be referenced after callback return * @param topic Zero terminated Topic text string, topic may not be referenced after callback return
* @param tot_len Total length of publish data, if set to 0 (no publish payload) data callback will not be invoked * @param tot_len Total length of publish data, if set to 0 (no publish payload) data callback will not be invoked
* @return Optional numerical topic identifier to be used in data callback
*/ */
typedef void (*mqtt_incoming_publish_cb_t)(void *arg, const char *topic, u32_t tot_len); typedef void (*mqtt_incoming_publish_cb_t)(void *arg, const char *topic, u32_t tot_len);