michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: use @rst/@endrst for ReST in headers

Browse source 
Folks found the use of @rststar/@endrststar non-intuitive (wanted to use
@rststart).  The "star" was there indicating the doxygen comment lines
had a leading asterisk that needed to be stripped, but since our
commenting convention is to use the leading asterisk on continuation
lines, the leading asterisk is always there.  So, change the doxygen
alias to the more expected @rst/@endrst.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-06-25 10:44:55 -07:00 • committed by Anas Nashif
commit 8de9cc7079
6 changed files with 76 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/shell/shell.h
View file

@ -852,11 +852,11 @@ void shell_help(const struct shell *shell);
*
* @param[in] shell Pointer to the shell instance.
* @rststar
* @rst
* It can be NULL when
* the :option:`CONFIG_SHELL_BACKEND_DUMMY` option is
* enabled.
* @endrststar
* @endrst
* @param[in] cmd Command to be executed.
*
* @returns Result of the execution