michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: doxygen: replace option alias with kconfig

Browse source 
Similar to Sphinx, @kconfig{} alias should be used in Doxygen docstring
in order to reference a Kconfig option. @option{} is still kept for
compatibility reasons.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-06-28 17:13:40 +02:00 • committed by Anas Nashif
commit 72ab6b29bf
17 changed files with 111 additions and 108 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/shell/shell.h
View file

@ -1024,7 +1024,7 @@ struct getopt_state *shell_getopt_state_get(const struct shell *shell);
*
* @param[in] shell Pointer to the shell instance.
* It can be NULL when the
* @option{CONFIG_SHELL_BACKEND_DUMMY} option is enabled.
* @kconfig{CONFIG_SHELL_BACKEND_DUMMY} option is enabled.
* @param[in] cmd Command to be executed.
*
* @return Result of the execution