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

22
include/kernel.h
View file

@ -1626,10 +1626,13 @@ static inline void *z_impl_k_timer_user_data_get(struct k_timer *timer)
* This routine returns the elapsed time since the system booted, * This routine returns the elapsed time since the system booted,
* in milliseconds. * in milliseconds.
* *
* @note While this function returns time in milliseconds, it does not mean it * @note
* has millisecond resolution. The actual resolution depends on * @rststar
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the default * While this function returns time in milliseconds, it does
* setting of 100, system time is updated in increments of 10ms. * not mean it has millisecond resolution. The actual resolution depends on
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the
* default setting of 100, system time is updated in increments of 10ms.
* @endrststar
* *
* @return Current uptime in milliseconds. * @return Current uptime in milliseconds.
*/ */
@ -1670,10 +1673,13 @@ void k_disable_sys_clock_always_on(void);
* cannot hold a system uptime time larger than approximately 50 days, so the * cannot hold a system uptime time larger than approximately 50 days, so the
* caller must handle possible rollovers. * caller must handle possible rollovers.
* *
* @note While this function returns time in milliseconds, it does not mean it * @note
* has millisecond resolution. The actual resolution depends on * @rststar
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the default * While this function returns time in milliseconds, it does
* setting of 100, system time is updated in increments of 10ms. * not mean it has millisecond resolution. The actual resolution depends on
* :option:`CONFIG_SYS_CLOCK_TICKS_PER_SEC` config option, and with the
* default setting of 100, system time is updated in increments of 10ms.
* @endrststar
* *
* @return Current uptime in milliseconds. * @return Current uptime in milliseconds.
*/ */

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 * @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. * 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 * @note
* of 1 minute. * @rststar
* Please modify :option:`CONFIG_MQTT_KEEPALIVE` time to override
* default of 1 minute.
* @endrststar
*/ */
int mqtt_connect(struct mqtt_client *client); int mqtt_connect(struct mqtt_client *client);

5
include/shell/shell.h
View file

@ -851,9 +851,12 @@ void shell_help(const struct shell *shell);
* This function must not be called from shell command context! * This function must not be called from shell command context!
* *
* @param[in] shell Pointer to the shell instance. It can be NULL when * @param[in] shell Pointer to the shell instance.
* @rststar
* It can be NULL when
* the :option:`CONFIG_SHELL_BACKEND_DUMMY` option is * the :option:`CONFIG_SHELL_BACKEND_DUMMY` option is
* enabled. * enabled.
* @endrststar
* @param[in] cmd Command to be executed. * @param[in] cmd Command to be executed.
* *
* @returns Result of the execution * @returns Result of the execution