michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: mqtt: Add missing Doxygen comments

Browse source 
Completed the documentation of the mqtt.h header file.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-07-20 10:53:04 +02:00 • committed by Anas Nashif
commit 660c5f5c98
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
include/zephyr/net/mqtt.h
View file

@ -11,9 +11,6 @@
* @{ * @{
* @brief MQTT Client Implementation * @brief MQTT Client Implementation
* *
* @details
* MQTT Client's Application interface is defined in this header.
*
* @note The implementation assumes TCP module is enabled. * @note The implementation assumes TCP module is enabled.
* *
* @note By default the implementation uses MQTT version 3.1.1. * @note By default the implementation uses MQTT version 3.1.1.
@ -207,36 +204,45 @@ struct mqtt_connack_param {
/** @brief Parameters for MQTT publish acknowledgment (PUBACK). */ /** @brief Parameters for MQTT publish acknowledgment (PUBACK). */
struct mqtt_puback_param { struct mqtt_puback_param {
/** Message id of the PUBLISH message being acknowledged */
uint16_t message_id; uint16_t message_id;
}; };
/** @brief Parameters for MQTT publish receive (PUBREC). */ /** @brief Parameters for MQTT publish receive (PUBREC). */
struct mqtt_pubrec_param { struct mqtt_pubrec_param {
/** Message id of the PUBLISH message being acknowledged */
uint16_t message_id; uint16_t message_id;
}; };
/** @brief Parameters for MQTT publish release (PUBREL). */ /** @brief Parameters for MQTT publish release (PUBREL). */
struct mqtt_pubrel_param { struct mqtt_pubrel_param {
/** Message id of the PUBREC message being acknowledged */
uint16_t message_id; uint16_t message_id;
}; };
/** @brief Parameters for MQTT publish complete (PUBCOMP). */ /** @brief Parameters for MQTT publish complete (PUBCOMP). */
struct mqtt_pubcomp_param { struct mqtt_pubcomp_param {
/** Message id of the PUBREL message being acknowledged */
uint16_t message_id; uint16_t message_id;
}; };
/** @brief Parameters for MQTT subscription acknowledgment (SUBACK). */ /** @brief Parameters for MQTT subscription acknowledgment (SUBACK). */
struct mqtt_suback_param { struct mqtt_suback_param {
/** Message id of the SUBSCRIBE message being acknowledged */
uint16_t message_id; uint16_t message_id;
/** Return codes indicating maximum QoS level granted for each topic
* in the subscription list.
*/
struct mqtt_binstr return_codes; struct mqtt_binstr return_codes;
}; };
/** @brief Parameters for MQTT unsubscribe acknowledgment (UNSUBACK). */ /** @brief Parameters for MQTT unsubscribe acknowledgment (UNSUBACK). */
struct mqtt_unsuback_param { struct mqtt_unsuback_param {
/** Message id of the UNSUBSCRIBE message being acknowledged */
uint16_t message_id; uint16_t message_id;
}; };
/** @brief Parameters for a publish message. */ /** @brief Parameters for a publish message (PUBLISH). */
struct mqtt_publish_param { struct mqtt_publish_param {
/** Messages including topic, QoS and its payload (if any) /** Messages including topic, QoS and its payload (if any)
* to be published. * to be published.