adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

net: doc: mqtt.h: Improve documentation

Browse source 
Some doxygen comments were missing.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
This commit is contained in:
Jukka Rissanen 2024-05-20 07:50:46 +03:00 committed by Carles Cufí
parent b711f5ac94
commit aa59ac9de1
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -6,16 +6,17 @@
/** @file mqtt.h
*
* @defgroup mqtt_socket MQTT Client library
* @since 1.14
* @version 0.8.0
* @ingroup networking
* @{
* @brief MQTT Client Implementation
*
* @note The implementation assumes TCP module is enabled.
*
* @note By default the implementation uses MQTT version 3.1.1.
*
* @defgroup mqtt_socket MQTT Client library
* @since 1.14
* @version 0.8.0
* @ingroup networking
* @{
*/
#ifndef ZEPHYR_INCLUDE_NET_MQTT_H_
@ -417,15 +418,16 @@ struct mqtt_transport {
*/
enum mqtt_transport_type type;
/** Use either unsecured TCP or secured TLS transport */
union {
/* TCP socket transport for MQTT */
/** TCP socket transport for MQTT */
struct {
/** Socket descriptor. */
int sock;
} tcp;
#if defined(CONFIG_MQTT_LIB_TLS)
/* TLS socket transport for MQTT */
/** TLS socket transport for MQTT */
struct {
/** Socket descriptor. */
int sock;
@ -559,7 +561,7 @@ struct mqtt_client {
*/
uint8_t clean_session : 1;
/* Userdata */
/** User specific opaque data */
void *user_data;
};