Skip to content

Commit

Permalink
doc: subsystems: shell: Add documentation.
Browse files Browse the repository at this point in the history
1. Remove old shell documentation.
2. Create documentation for new shell module.
3. Fix shell.h comments to be able to generate
   API documentation.

Signed-off-by: Jakub Rzeszutko <jakub.rzeszutko@nordicsemi.no>
  • Loading branch information
Jakub Rzeszutko authored and nashif committed Sep 29, 2018
1 parent 8dce59b commit bef64c3
Show file tree
Hide file tree
Showing 9 changed files with 598 additions and 235 deletions.
1 change: 1 addition & 0 deletions doc/api/api.rst
Expand Up @@ -27,3 +27,4 @@ The Zephyr APIs are used the same way on all SoCs and boards.
display_api
misc_api
logger_api
shell_api
16 changes: 16 additions & 0 deletions doc/api/shell_api.rst
@@ -0,0 +1,16 @@

.. _shell_api:

Shell system API
#################

.. contents::
:depth: 2
:local:
:backlinks: top

Shell API
**********

.. doxygengroup:: shell_api
:project: Zephyr
182 changes: 0 additions & 182 deletions doc/subsystems/shell.rst

This file was deleted.

Binary file added doc/subsystems/shell/images/dynamic_cmd.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/subsystems/shell/images/static_cmd.PNG
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/subsystems/shell/images/wildcard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bef64c3

Please sign in to comment.