sys/shell: fixed and unified doxygen headers

- changed doxygen group name to sys_shell - added some missing fields - unified the doxygen header format
RIOT-OS · Mar 31, 2015 · 581e3c7 · 581e3c7
1 parent 95ae911
commit 581e3c7
Show file tree

Hide file tree

Showing 23 changed files with 174 additions and 126 deletions.
diff --git a/sys/include/shell.h b/sys/include/shell.h
@@ -10,6 +10,11 @@
  * @defgroup    sys_shell Shell
  * @ingroup     sys
  * @brief       Simple shell interpreter
+ *
+ * @{
+ *
+ * @file
+ * @brief       Shell interface definition
  */
 
 #ifndef __SHELL_H
@@ -93,3 +98,4 @@ void shell_run(shell_t *shell) NORETURN;
 #endif
 
 #endif /* __SHELL_H */
+/** @} */
diff --git a/sys/include/shell_commands.h b/sys/include/shell_commands.h
@@ -6,6 +6,17 @@
  * directory for more details.
  */
 
+/**
+ * @ingroup     sys_shell_commands
+ *
+ * @{
+ *
+ * @file
+ * @brief       Shell command definitions
+ *
+ * @author      Kaspar Schleiser <kaspar@schleiser.de>
+ */
+
 #ifndef __SHELL_COMMANDS_H
 #define __SHELL_COMMANDS_H
 
@@ -28,3 +39,4 @@ extern const shell_command_t _shell_command_list[];
 #endif
 
 #endif /* __SHELL_COMMANDS_H */
+/** @} */
diff --git a/sys/shell/commands/sc_cc110x_legacy_csma.c b/sys/shell/commands/sc_cc110x_legacy_csma.c
@@ -1,18 +1,21 @@
-/**
- * Shell commands for the cc110x driver without a transceiver
- *
+/*
  * Copyright (C) 2013  INRIA.
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_cc110x_legacy_csma.c
- * @brief   provides shell commands to configure the cc110x driver
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
- * @author  Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
+ *
+ * @file
+ * @brief       Provides shell commands to configure the cc110x driver
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ * @author      Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_disk.c b/sys/shell/commands/sc_disk.c
@@ -1,17 +1,20 @@
-/**
- * Shell commands for accessing storage
- *
+/*
  * Copyright (C) 2013  INRIA.
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_disk.c
- * @brief   provides shell commands to access storage (like mmc)
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ *
+ * @file
+ * @brief       Provides shell commands to access storage (like MMC)
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_heap.c b/sys/shell/commands/sc_heap.c
@@ -1,6 +1,4 @@
 /*
- * sc_heap.c - the handler of the heap state on the command shell.
- *
  * Copyright (C) 2013 Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
  *
  * This file is subject to the terms and conditions of the GNU Lesser
@@ -9,13 +7,15 @@
  */
 
 /**
+ * @ingroup     sys_shell_commands
+ * @{
+ *
  * @file
- * @internal
- * @brief   Show the heap state for the LPC2387 on the command shell.
+ * @brief       Print the state of the heap
  *
- * @author  Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
+ * @author      Zakaria Kasmi <zkasmi@inf.fu-berlin.de>
  *
- * @note    $Id: sc_heap.c 3855 2013-09-05 12:40:11 kasmi $
+ * @}
  */
 
 extern void heap_stats(void);

diff --git a/sys/shell/commands/sc_id.c b/sys/shell/commands/sc_id.c
@@ -1,17 +1,20 @@
-/**
- * Shell commands for configuring the node id
- *
+/*
  * Copyright (C) 2014  INRIA.
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_id.c
- * @brief   provides shell commands to configure node id
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ *
+ * @file
+ * @brief       Provides shell commands to configure node id
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_isl29020.c b/sys/shell/commands/sc_isl29020.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
  *
  * @file

diff --git a/sys/shell/commands/sc_l2_ping.c b/sys/shell/commands/sc_l2_ping.c
@@ -1,17 +1,20 @@
 /*
- * Shell commands for l2_ping module
- *
  * Copyright (C) 2014, INRIA
  *
  * This file is subject to the terms and conditions of the GNU Lesser General
  * Public License v2.1. See the file LICENSE in the top level directory for
  * more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
+ *
  * @file
- * @brief   provides shell commands use link layer ping functionality
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ * @brief       Provides shell commands to use link layer ping functionality
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_l3g4200d.c b/sys/shell/commands/sc_l3g4200d.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
  *
  * @file

diff --git a/sys/shell/commands/sc_lps331ap.c b/sys/shell/commands/sc_lps331ap.c
@@ -7,7 +7,7 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
  *
  * @file

diff --git a/sys/shell/commands/sc_lsm303dlhc.c b/sys/shell/commands/sc_lsm303dlhc.c
@@ -7,11 +7,11 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
  *
  * @file
- * @brief       provides shell commands to poll lsm303dlhc sensor
+ * @brief       Provides shell commands to poll lsm303dlhc sensor
  *
  * @author      Thomas Eichinger <thomas.eichinger@fu-berlin.de>
  *

diff --git a/sys/shell/commands/sc_ltc4150.c b/sys/shell/commands/sc_ltc4150.c
@@ -1,17 +1,20 @@
-/**
- * Shell commands for coulomb counter
- *
+/*
  * Copyright (C) 2013  INRIA.
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_ltc4150.c
- * @brief   provides shell commands to access ltc4150
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ *
+ * @file
+ * @brief       Provides shell commands to access ltc4150
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_mersenne.c b/sys/shell/commands/sc_mersenne.c
@@ -1,17 +1,20 @@
-/**
- * Shell commands for mersenne twister
- *
+/*
  * Copyright (C) 2013 Freie Universität Berlin
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_mersenne.c
- * @brief   initializes the PRNG
- * @author  Christian Mehlis <mehlis@inf.fu-berlin.de>
+ *
+ * @file
+ * @brief       Shell commands for mersenne twister
+ *
+ * @author      Christian Mehlis <mehlis@inf.fu-berlin.de>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_net_if.c b/sys/shell/commands/sc_net_if.c
@@ -1,6 +1,4 @@
 /*
- * Shell commands for network interfaces
- *
  * Copyright (C) 2013 Martine Lenders <mlenders@inf.fu-berlin.de>
  *
  * This file is subject to the terms and conditions of the GNU Lesser
@@ -9,11 +7,14 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_net_if.c
- * @brief   provides shell commands to configure network interfaces
- * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
+ *
+ * @file
+ * @brief       Provides shell commands to configure network interfaces
+ *
+ * @author      Martine Lenders <mlenders@inf.fu-berlin.de>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_ps.c b/sys/shell/commands/sc_ps.c
@@ -1,17 +1,20 @@
-/**
- * Shell commands for ps
- *
+/*
  * Copyright (C) 2013  INRIA.
  *
  * This file is subject to the terms and conditions of the GNU Lesser
  * General Public License v2.1. See the file LICENSE in the top level
  * directory for more details.
- *
- * @ingroup shell_commands
+ */
+
+/**
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_ps.c
- * @brief   shows all thread information
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ *
+ * @file
+ * @brief       Shell commands for the PS module
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_rpl.c b/sys/shell/commands/sc_rpl.c
@@ -7,11 +7,14 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
- * @file    sc_rpl.c
- * @brief   provides shell commands to manage and query RPL
- * @author  Oliver Hahm <oliver.hahm@inria.fr>
+ *
+ * @file
+ * @brief       Provides shell commands to manage and query RPL
+ *
+ * @author      Oliver Hahm <oliver.hahm@inria.fr>
+ *
  * @}
  */
 

diff --git a/sys/shell/commands/sc_rtc.c b/sys/shell/commands/sc_rtc.c
@@ -8,13 +8,15 @@
  */
 
 /**
- * @ingroup shell_commands
+ * @ingroup     sys_shell_commands
  * @{
+ *
  * @file
- * @brief   Shell command implementation for the peripheral RTC interface
+ * @brief       Shell command implementation for the peripheral RTC interface
  *
  * @author  Oliver Hahm <oliver.hahm@inria.fr>
- * @author  Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>
+ * @author  Ludwig Ortmann <ludwig.ortmann@fu-berlin.de>#
+ *
  * @}
  */