sys: fix doxygen grouping

2018-06-01 13:19:39 +02:00 · 2018-06-01 13:19:39 +02:00 · 7d013eb2b6
commit 7d013eb2b6
parent bd2845adf6
29 changed files with 57 additions and 29 deletions
--- a/sys/auto_init/auto_init.c
+++ b/sys/auto_init/auto_init.c
@ -7,7 +7,7 @@
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 *
- * @ingroup auto_init
+ * @ingroup sys_autoinit
 * @{
 * @file
 * @brief   initializes any used module that has a trivial init function
--- a/sys/auto_init/can/auto_init_can.c
+++ b/sys/auto_init/can/auto_init_can.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup auto_init
+ * @ingroup     sys_autoinit
 * @{
 * @file
 * @brief       initializes can device init function
--- a/sys/auto_init/can/auto_init_can_native.c
+++ b/sys/auto_init/can/auto_init_can_native.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup auto_init
+ * @ingroup     sys_autoinit
 * @{
 * @file
 * @brief       initializes native can device
--- a/sys/base64/base64.c
+++ b/sys/base64/base64.c
@ -8,7 +8,7 @@
 */

 /**
- * @ingroup base64
+ * @ingroup sys_base64
 * @{
 * @file
 * @brief   Functions to encode and decode base64
--- a/sys/crypto/modes/cbc.c
+++ b/sys/crypto/modes/cbc.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     sys_crypto_modes
+ * @ingroup     sys_crypto
 * @{
 *
 * @file
--- a/sys/crypto/modes/ccm.c
+++ b/sys/crypto/modes/ccm.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     sys_crypto_modes
+ * @ingroup     sys_crypto
 * @{
 *
 * @file
--- a/sys/crypto/modes/ctr.c
+++ b/sys/crypto/modes/ctr.c
@ -7,7 +7,7 @@
 */

 /**
-* @ingroup     sys_crypto_modes
+* @ingroup     sys_crypto
 * @{
 *
 * @file
--- a/sys/crypto/modes/ecb.c
+++ b/sys/crypto/modes/ecb.c
@ -7,7 +7,7 @@
 */

 /**
-* @ingroup     sys_crypto_modes
+* @ingroup     sys_crypto
 * @{
 *
 * @file
--- a/sys/div/div.c
+++ b/sys/div/div.c
@ -5,7 +5,7 @@
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 *
- * @ingroup sys_util
+ * @ingroup     sys_div
 * @{
 * @file
 * @brief    Integer division function implementations
--- a/sys/fs/devfs/auto_init_devfs.c
+++ b/sys/fs/devfs/auto_init_devfs.c
@ -8,7 +8,7 @@
 */

 /**
- * @ingroup     auto_init_fs
+ * @ingroup     sys_autoinit
 * @{
 *
 * @file
--- a/sys/include/crypto/modes/cbc.h
+++ b/sys/include/crypto/modes/cbc.h
@ -70,3 +70,4 @@ int cipher_decrypt_cbc(cipher_t *cipher, uint8_t iv[16], const uint8_t *input,
 #endif

 #endif /* CRYPTO_MODES_CBC_H */
+/** @} */
--- a/sys/include/crypto/modes/ccm.h
+++ b/sys/include/crypto/modes/ccm.h
@ -26,11 +26,16 @@
 extern "C" {
 #endif

-#define CCM_ERR_INVALID_NONCE_LENGTH -2
-#define CCM_ERR_INVALID_CBC_MAC -3
-#define CCM_ERR_INVALID_DATA_LENGTH -3
-#define CCM_ERR_INVALID_LENGTH_ENCODING -4
-#define CCM_ERR_INVALID_MAC_LENGTH -5
+/**
+ * @name CCM error codes
+ * @{
+ */
+#define CCM_ERR_INVALID_NONCE_LENGTH        (-2)
+#define CCM_ERR_INVALID_CBC_MAC             (-3)
+#define CCM_ERR_INVALID_DATA_LENGTH         (-3)
+#define CCM_ERR_INVALID_LENGTH_ENCODING     (-4)
+#define CCM_ERR_INVALID_MAC_LENGTH          (-5)
+/** @} */

 /**
 * @brief Encrypt and authenticate data of arbitrary length in ccm mode.
@ -86,3 +91,4 @@ int cipher_decrypt_ccm(cipher_t* cipher, uint8_t* auth_data,
 #endif

 #endif /* CRYPTO_MODES_CCM_H */
+/** @} */
--- a/sys/include/crypto/modes/ctr.h
+++ b/sys/include/crypto/modes/ctr.h
@ -71,3 +71,4 @@ int cipher_decrypt_ctr(cipher_t* cipher, uint8_t nonce_counter[16],
 #endif

 #endif /* CRYPTO_MODES_CTR_H */
+/** @} */
--- a/sys/include/crypto/modes/ecb.h
+++ b/sys/include/crypto/modes/ecb.h
@ -60,3 +60,4 @@ int cipher_decrypt_ecb(cipher_t* cipher, uint8_t* input, size_t length,
 #endif

 #endif /* CRYPTO_MODES_ECB_H */
+/** @} */
--- a/sys/include/net/nanocoap_sock.h
+++ b/sys/include/net/nanocoap_sock.h
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     sys_net_nanocoap
+ * @ingroup     net_nanocoap
 *
 * @{
 *
--- a/sys/include/shell_commands.h
+++ b/sys/include/shell_commands.h
@ -7,7 +7,8 @@
 */

 /**
- * @ingroup     sys_shell_commands
+ * @defgroup    sys_shell_commands Shell commands
+ * @ingroup     sys
 *
 * @{
 *
@ -26,12 +27,20 @@
 extern "C" {
 #endif

+/**
+ * @name    Disk manipulation command names
+ * @{
+ */
 #define DISK_GET_SECTOR_SIZE    "dget_ssize"
 #define DISK_GET_SECTOR_COUNT   "dget_scount"
 #define DISK_GET_BLOCK_SIZE     "dget_bsize"
 #define DISK_READ_SECTOR_CMD    "dread_sec"
 #define DISK_READ_BYTES_CMD     "dread"
+/** @} */

+/**
+ * @brief   List of shell commands
+ */
 extern const shell_command_t _shell_command_list[];

 #ifdef __cplusplus
--- a/sys/net/application_layer/nanocoap/nanocoap.c
+++ b/sys/net/application_layer/nanocoap/nanocoap.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     sys_net_nanocoap
+ * @ingroup     net_nanocoap
 * @{
 *
 * @file
--- a/sys/net/application_layer/nanocoap/sock.c
+++ b/sys/net/application_layer/nanocoap/sock.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     sys_net_nanocoap
+ * @ingroup     net_nanocoap
 * @{
 *
 * @file
--- a/sys/net/gnrc/pktdump/gnrc_pktdump.c
+++ b/sys/net/gnrc/pktdump/gnrc_pktdump.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     net_pktdump
+ * @ingroup     net_gnrc_pktdump
 * @{
 *
 * @file
--- a/sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c
+++ b/sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c
@ -8,7 +8,7 @@
 */

 /*
- * @ingroup gnrc_rpl
+ * @ingroup net_gnrc_rpl
 * @{
 *
 * @file
--- a/sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c
+++ b/sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c
@ -10,7 +10,7 @@

 /**
 *
- * @ingroup rpl
+ * @ingroup net_gnrc_rpl
 * @{
 * @file
 * @brief   RPL Objective functions manager
--- a/sys/net/transport_layer/tcp/tcp_hdr_print.c
+++ b/sys/net/transport_layer/tcp/tcp_hdr_print.c
@ -7,6 +7,7 @@
 */

 /**
+ * @ingroup     net_tcp
 * @{
 *
 * @file
--- a/sys/net/transport_layer/udp/udp_hdr_print.c
+++ b/sys/net/transport_layer/udp/udp_hdr_print.c
@ -7,7 +7,7 @@
 */

 /**
- * @ingroup     net_pktdump
+ * @ingroup     net_udp
 * @{
 *
 * @file
--- a/sys/newlib_syscalls_default/syscalls.c
+++ b/sys/newlib_syscalls_default/syscalls.c
@ -8,7 +8,9 @@
 */

 /**
- * @ingroup     sys_newlib
+ * @defgroup    sys_newlib Newlib system call
+ * @ingroup     sys
+ * @brief       Newlib system call
 * @{
 *
 * @file
--- a/sys/posix/time/posix_time.c
+++ b/sys/posix/time/posix_time.c
@ -4,8 +4,11 @@
 * 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 sys_xtimer
 *
- * @ingroup xtimer
 * @{
 * @file
 * @brief xtimer posix wrapper
--- a/sys/ps/ps.c
+++ b/sys/ps/ps.c
@ -7,7 +7,7 @@
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 *
- * @ingroup ps
+ * @ingroup sys_ps
 * @{
 * @file
 * @brief   UNIX like ps command
--- a/sys/shell/commands/sc_gnrc_rpl.c
+++ b/sys/shell/commands/sc_gnrc_rpl.c
@ -8,7 +8,7 @@
 */

 /**
- * @ingroup     sys_shell_commands.h
+ * @ingroup     sys_shell_commands
 * @{
 *
 * @file
--- a/sys/xtimer/xtimer.c
+++ b/sys/xtimer/xtimer.c
@ -8,7 +8,8 @@
 */

 /**
- * @ingroup xtimer
+ * @ingroup sys_xtimer
+ *
 * @{
 * @file
 * @brief xtimer convenience functionality
--- a/sys/xtimer/xtimer_core.c
+++ b/sys/xtimer/xtimer_core.c
@ -5,8 +5,11 @@
 * 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 sys_xtimer
 *
- * @ingroup xtimer
 * @{
 * @file
 * @brief xtimer core functionality