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

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!
*
* @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
* enabled.
* @endrststar
* @param[in] cmd Command to be executed.
*
* @returns Result of the execution