From 7d013eb2b6fb0c4b1e1ba93e566d95f8ad55d55d Mon Sep 17 00:00:00 2001
From: Alexandre Abadie <alexandre.abadie@inria.fr>
Date: Fri, 1 Jun 2018 13:19:39 +0200
Subject: [PATCH] sys: fix doxygen grouping
---
sys/auto_init/auto_init.c | 2 +-
sys/auto_init/can/auto_init_can.c | 2 +-
sys/auto_init/can/auto_init_can_native.c | 2 +-
sys/base64/base64.c | 2 +-
sys/crypto/modes/cbc.c | 2 +-
sys/crypto/modes/ccm.c | 2 +-
sys/crypto/modes/ctr.c | 2 +-
sys/crypto/modes/ecb.c | 2 +-
sys/div/div.c | 2 +-
sys/fs/devfs/auto_init_devfs.c | 2 +-
sys/include/crypto/modes/cbc.h | 1 +
sys/include/crypto/modes/ccm.h | 16 +++++++++++-----
sys/include/crypto/modes/ctr.h | 1 +
sys/include/crypto/modes/ecb.h | 1 +
sys/include/net/nanocoap_sock.h | 2 +-
sys/include/shell_commands.h | 11 ++++++++++-
sys/net/application_layer/nanocoap/nanocoap.c | 2 +-
sys/net/application_layer/nanocoap/sock.c | 2 +-
sys/net/gnrc/pktdump/gnrc_pktdump.c | 2 +-
sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c | 2 +-
sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c | 2 +-
sys/net/transport_layer/tcp/tcp_hdr_print.c | 1 +
sys/net/transport_layer/udp/udp_hdr_print.c | 2 +-
sys/newlib_syscalls_default/syscalls.c | 4 +++-
sys/posix/time/posix_time.c | 5 ++++-
sys/ps/ps.c | 2 +-
sys/shell/commands/sc_gnrc_rpl.c | 2 +-
sys/xtimer/xtimer.c | 3 ++-
sys/xtimer/xtimer_core.c | 5 ++++-
29 files changed, 57 insertions(+), 29 deletions(-)
diff --git a/sys/auto_init/auto_init.c b/sys/auto_init/auto_init.c
index 7d47c6334d..374d7affab 100644
--- 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
diff --git a/sys/auto_init/can/auto_init_can.c b/sys/auto_init/can/auto_init_can.c
index c5f9dfa1fc..3005371f86 100644
--- 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
diff --git a/sys/auto_init/can/auto_init_can_native.c b/sys/auto_init/can/auto_init_can_native.c
index c6bb4f76f0..43cd607628 100644
--- 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
diff --git a/sys/base64/base64.c b/sys/base64/base64.c
index ad5ed6d032..048fc99f48 100644
--- 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
diff --git a/sys/crypto/modes/cbc.c b/sys/crypto/modes/cbc.c
index 21e193569d..159f0b54f5 100644
--- a/sys/crypto/modes/cbc.c
+++ b/sys/crypto/modes/cbc.c
@@ -7,7 +7,7 @@
*/
/**
- * @ingroup sys_crypto_modes
+ * @ingroup sys_crypto
* @{
*
* @file
diff --git a/sys/crypto/modes/ccm.c b/sys/crypto/modes/ccm.c
index 0df28fa4bd..657c76b47e 100644
--- a/sys/crypto/modes/ccm.c
+++ b/sys/crypto/modes/ccm.c
@@ -7,7 +7,7 @@
*/
/**
- * @ingroup sys_crypto_modes
+ * @ingroup sys_crypto
* @{
*
* @file
diff --git a/sys/crypto/modes/ctr.c b/sys/crypto/modes/ctr.c
index 8ede351094..24034c53a2 100644
--- a/sys/crypto/modes/ctr.c
+++ b/sys/crypto/modes/ctr.c
@@ -7,7 +7,7 @@
*/
/**
-* @ingroup sys_crypto_modes
+* @ingroup sys_crypto
* @{
*
* @file
diff --git a/sys/crypto/modes/ecb.c b/sys/crypto/modes/ecb.c
index a2c0da8843..183e5bfdc9 100644
--- a/sys/crypto/modes/ecb.c
+++ b/sys/crypto/modes/ecb.c
@@ -7,7 +7,7 @@
*/
/**
-* @ingroup sys_crypto_modes
+* @ingroup sys_crypto
* @{
*
* @file
diff --git a/sys/div/div.c b/sys/div/div.c
index 95b171ed16..675b3e249f 100644
--- 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
diff --git a/sys/fs/devfs/auto_init_devfs.c b/sys/fs/devfs/auto_init_devfs.c
index 9de9b57057..011af83d40 100644
--- 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
diff --git a/sys/include/crypto/modes/cbc.h b/sys/include/crypto/modes/cbc.h
index 2b8d8f0bd9..74ee616a92 100644
--- 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 */
+/** @} */
diff --git a/sys/include/crypto/modes/ccm.h b/sys/include/crypto/modes/ccm.h
index d2f076bf48..b61c2d1238 100644
--- 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 */
+/** @} */
diff --git a/sys/include/crypto/modes/ctr.h b/sys/include/crypto/modes/ctr.h
index 62925f0692..7c5b493fef 100644
--- 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 */
+/** @} */
diff --git a/sys/include/crypto/modes/ecb.h b/sys/include/crypto/modes/ecb.h
index 39f86c3377..4e04067c28 100644
--- 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 */
+/** @} */
diff --git a/sys/include/net/nanocoap_sock.h b/sys/include/net/nanocoap_sock.h
index e7b2c98bb3..835f868b39 100644
--- 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
*
* @{
*
diff --git a/sys/include/shell_commands.h b/sys/include/shell_commands.h
index 0c306d093d..11dbe97a09 100644
--- 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
diff --git a/sys/net/application_layer/nanocoap/nanocoap.c b/sys/net/application_layer/nanocoap/nanocoap.c
index d5b9c0c721..be3f7482f1 100644
--- 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
diff --git a/sys/net/application_layer/nanocoap/sock.c b/sys/net/application_layer/nanocoap/sock.c
index 96c651b298..aaec5b99b9 100644
--- 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
diff --git a/sys/net/gnrc/pktdump/gnrc_pktdump.c b/sys/net/gnrc/pktdump/gnrc_pktdump.c
index bd177a400f..dc9036f8c1 100644
--- 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
diff --git a/sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c b/sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c
index f6f2ea4c67..d5e0ba3ee3 100644
--- 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
diff --git a/sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c b/sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c
index 3bd65b18fa..28842e74b9 100644
--- 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
diff --git a/sys/net/transport_layer/tcp/tcp_hdr_print.c b/sys/net/transport_layer/tcp/tcp_hdr_print.c
index b7dfcb50d2..b81606d14f 100644
--- 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
diff --git a/sys/net/transport_layer/udp/udp_hdr_print.c b/sys/net/transport_layer/udp/udp_hdr_print.c
index 0d22ae84f7..c909d478c4 100644
--- 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
diff --git a/sys/newlib_syscalls_default/syscalls.c b/sys/newlib_syscalls_default/syscalls.c
index 91543fcd18..a2ecc1b6e4 100644
--- 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
diff --git a/sys/posix/time/posix_time.c b/sys/posix/time/posix_time.c
index 188a8f0bf6..ae78095968 100644
--- 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
diff --git a/sys/ps/ps.c b/sys/ps/ps.c
index dd88059005..1a307ca523 100644
--- 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
diff --git a/sys/shell/commands/sc_gnrc_rpl.c b/sys/shell/commands/sc_gnrc_rpl.c
index c592c5a6b8..c41fc07d6c 100644
--- 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
diff --git a/sys/xtimer/xtimer.c b/sys/xtimer/xtimer.c
index 612bbc9622..ff6dccf0f4 100644
--- a/sys/xtimer/xtimer.c
+++ b/sys/xtimer/xtimer.c
@@ -8,7 +8,8 @@
*/
/**
- * @ingroup xtimer
+ * @ingroup sys_xtimer
+ *
* @{
* @file
* @brief xtimer convenience functionality
diff --git a/sys/xtimer/xtimer_core.c b/sys/xtimer/xtimer_core.c
index d5765de89b..af7a0a2466 100644
--- 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
--
GitLab