kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-31 09:21:19 +01:00
Code Releases Activity

sys/shell: fix doc

Browse Source 
Fixed broken Markdown code spans. Also added a code span around mention
of getopt.
This commit is contained in:
Joshua DeWeese 2023-12-21 14:48:41 -05:00
parent 418bc2f93a
commit fcd3d0decf
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sys/include/shell.h
View File

@ -112,14 +112,14 @@ void shell_post_command_hook(int ret, int argc, char **argv);
/**
* @brief Protype of a shell callback handler.
* @details The functions supplied to shell_run() must use this signature.
* The argument list is terminated with a NULL, i.e ``argv[argc] == NULL`.
* ``argv[0]`` is the function name.
* The argument list is terminated with a `NULL`, i.e `argv[argc] == NULL`.
* `argv[0]` is the function name.
*
* Escape sequences are removed before the function is called.
*
* The called function may edit `argv` and the contained strings,
* but it must be taken care of not to leave the boundaries of the array.
* This functionality can be used by getopt() or a similar function.
* This functionality can be used by `getopt()` or a similar function.
* @param[in] argc Number of arguments supplied to the function invocation.
* @param[in] argv The supplied argument list.
*