michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix doxygen comments with embedded reST

Browse source 
Doxygen comments can include doxygen-specific markup tags.  If other
markup tags are used (e.g., restructuredText) we need to indicate that
in the doxygen comments (via @rststar/@endrststar tags).

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-06-10 11:13:33 -07:00 • committed by Anas Nashif
commit 00c41ea893
3 changed files with 23 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/net/mqtt.h
View file

@ -514,8 +514,11 @@ void mqtt_client_init(struct mqtt_client *client);
*
* @note Default protocol revision used for connection request is 3.1.1. Please
* set client.protocol_version = MQTT_VERSION_3_1_0 to use protocol 3.1.0.
* @note Please modify :option:`CONFIG_MQTT_KEEPALIVE` time to override default
* of 1 minute.
* @note
* @rststar
* Please modify :option:`CONFIG_MQTT_KEEPALIVE` time to override
* default of 1 minute.
* @endrststar
*/
int mqtt_connect(struct mqtt_client *client);