1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-17 05:32:45 +01:00

sys/shell: update doc

This patch updates shell.c's doc that undersells the shells complexity.
The comment seems to have been written prior to the shell's ability to
parse command args and handle quoting sequences.
This commit is contained in:
Joshua DeWeese 2023-12-21 16:18:23 -05:00
parent 5cd52885c1
commit edb419ab7c

View File

@ -13,11 +13,12 @@
* @{
*
* @file
* @brief Implementation of a very simple command interpreter.
* @brief Implementation of a simple command interpreter.
* For each command (i.e. "echo"), a handler can be specified.
* If the first word of a user-entered command line matches the
* name of a handler, the handler will be called with the whole
* command line as parameter.
* name of a handler, the handler will be called with the remaining
* arguments passed in a manner similar to `main()`'s argc/argv
* parameters.
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
* @author René Kijewski <rene.kijewski@fu-berlin.de>