michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: update Kconfig options to use @option ALIAS

Browse source 
This updates Kconfig options in the Doxygen documentation to use the new
@option ALIAS. There are three categories of fixes:

* Use of `:option:` inside Doxygen headers, which is not valid (this is
  rST syntax!).
* Kconfig options that were just written as plain text and were no
  references were generated.
* Use of `@rst` blocks where the only reason for using them was to have
  Kconfig options resolved.

Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no>
This commit is contained in:
Fabio Utzig 2020-09-11 10:14:37 -03:00 • committed by Carles Cufí
commit 39fa56b834
7 changed files with 49 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

7
include/shell/shell.h
View file

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