Skip to content

Commit c4bef30

Browse files
committed
[nrf fromtree] net: mqtt: Make sure MQTT 5.0 is visible in API documentation
Make sure conditionally compiled parts of the public header related to MQTT 5.0 support are rendered by doxygen. Signed-off-by: Robert Lubos <[email protected]> (cherry picked from commit f9b4e27)
1 parent 5b09052 commit c4bef30

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

include/zephyr/net/mqtt.h

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ struct mqtt_connack_param {
292292
*/
293293
uint8_t return_code;
294294

295-
#if defined(CONFIG_MQTT_VERSION_5_0)
295+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
296296
struct {
297297
/** MQTT 5.0, chapter 3.2.2.3.10 User Property. */
298298
struct mqtt_utf8_pair user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX];
@@ -408,7 +408,7 @@ struct mqtt_puback_param {
408408
/** Message id of the PUBLISH message being acknowledged */
409409
uint16_t message_id;
410410

411-
#if defined(CONFIG_MQTT_VERSION_5_0)
411+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
412412
/** MQTT 5.0 reason code. */
413413
uint8_t reason_code;
414414

@@ -422,7 +422,7 @@ struct mqtt_pubrec_param {
422422
/** Message id of the PUBLISH message being acknowledged */
423423
uint16_t message_id;
424424

425-
#if defined(CONFIG_MQTT_VERSION_5_0)
425+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
426426
/** MQTT 5.0 reason code. */
427427
uint8_t reason_code;
428428

@@ -436,7 +436,7 @@ struct mqtt_pubrel_param {
436436
/** Message id of the PUBREC message being acknowledged */
437437
uint16_t message_id;
438438

439-
#if defined(CONFIG_MQTT_VERSION_5_0)
439+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
440440
/** MQTT 5.0 reason code. */
441441
uint8_t reason_code;
442442

@@ -450,7 +450,7 @@ struct mqtt_pubcomp_param {
450450
/** Message id of the PUBREL message being acknowledged */
451451
uint16_t message_id;
452452

453-
#if defined(CONFIG_MQTT_VERSION_5_0)
453+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
454454
/** MQTT 5.0 reason code. */
455455
uint8_t reason_code;
456456

@@ -471,7 +471,7 @@ struct mqtt_suback_param {
471471
*/
472472
struct mqtt_binstr return_codes;
473473

474-
#if defined(CONFIG_MQTT_VERSION_5_0)
474+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
475475
/** MQTT 5.0 properties. */
476476
struct mqtt_common_ack_properties prop;
477477
#endif /* CONFIG_MQTT_VERSION_5_0 */
@@ -482,7 +482,7 @@ struct mqtt_unsuback_param {
482482
/** Message id of the UNSUBSCRIBE message being acknowledged */
483483
uint16_t message_id;
484484

485-
#if defined(CONFIG_MQTT_VERSION_5_0)
485+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
486486
/** Reason codes corresponding to each topic in the unsubscription list. */
487487
struct mqtt_binstr reason_codes;
488488

@@ -511,7 +511,7 @@ struct mqtt_publish_param {
511511
*/
512512
uint8_t retain_flag : 1;
513513

514-
#if defined(CONFIG_MQTT_VERSION_5_0)
514+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
515515
/** MQTT 5.0 properties. */
516516
struct {
517517
/** MQTT 5.0, chapter 3.3.2.3.7 User Property. */
@@ -572,7 +572,7 @@ struct mqtt_subscription_list {
572572
/** Message id used to identify subscription request. */
573573
uint16_t message_id;
574574

575-
#if defined(CONFIG_MQTT_VERSION_5_0)
575+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
576576
/** MQTT 5.0 properties. */
577577
struct {
578578
/** MQTT 5.0, chapter 3.8.2.1.3 / 3.10.2.1.2 User Property. */
@@ -588,7 +588,7 @@ struct mqtt_subscription_list {
588588

589589
/** @brief Parameters for disconnect message. */
590590
struct mqtt_disconnect_param {
591-
#if defined(CONFIG_MQTT_VERSION_5_0)
591+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
592592
/* MQTT 5.0 Disconnect reason code. */
593593
enum mqtt_disconnect_reason_code reason_code;
594594

@@ -621,7 +621,7 @@ struct mqtt_disconnect_param {
621621
#endif /* CONFIG_MQTT_VERSION_5_0 */
622622
};
623623

624-
#if defined(CONFIG_MQTT_VERSION_5_0)
624+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
625625
struct mqtt_auth_param {
626626
/* MQTT 5.0, chapter 3.15.2.1 Authenticate Reason Code */
627627
enum mqtt_auth_reason_code reason_code;
@@ -688,7 +688,7 @@ union mqtt_evt_param {
688688
/** Parameters accompanying MQTT_EVT_UNSUBACK event. */
689689
struct mqtt_unsuback_param unsuback;
690690

691-
#if defined(CONFIG_MQTT_VERSION_5_0)
691+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
692692
/** Parameters accompanying MQTT_EVT_DISCONNECT event. */
693693
struct mqtt_disconnect_param disconnect;
694694

@@ -876,7 +876,7 @@ struct mqtt_internal {
876876
/** Internal. Remaining payload length to read. */
877877
uint32_t remaining_payload;
878878

879-
#if defined(CONFIG_MQTT_VERSION_5_0)
879+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
880880
/** Internal. MQTT 5.0 topic alias mapping. */
881881
struct mqtt_topic_alias topic_aliases[CONFIG_MQTT_TOPIC_ALIAS_MAX];
882882

@@ -915,7 +915,7 @@ struct mqtt_client {
915915
*/
916916
struct mqtt_utf8 *password;
917917

918-
#if defined(CONFIG_MQTT_VERSION_5_0)
918+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
919919
/** MQTT 5.0 Will properties. */
920920
struct {
921921
/** MQTT 5.0, chapter 3.1.3.2.8 User Property. */
@@ -976,7 +976,7 @@ struct mqtt_client {
976976
/** Unanswered PINGREQ count on this connection. */
977977
int8_t unacked_ping;
978978

979-
#if defined(CONFIG_MQTT_VERSION_5_0)
979+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
980980
/** MQTT 5.0 properties. */
981981
struct {
982982
/** MQTT 5.0, chapter 3.1.2.11.8 User Property. */
@@ -1186,7 +1186,7 @@ int mqtt_ping(struct mqtt_client *client);
11861186
int mqtt_disconnect(struct mqtt_client *client,
11871187
const struct mqtt_disconnect_param *param);
11881188

1189-
#if defined(CONFIG_MQTT_VERSION_5_0)
1189+
#if defined(CONFIG_MQTT_VERSION_5_0) || defined(__DOXYGEN__)
11901190
/**
11911191
* @brief API to send an authentication packet to the server.
11921192
*

0 commit comments

Comments
 (0)