riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

sys: fix doxygen grouping

Browse Source
This commit is contained in:
Alexandre Abadie 2018-06-01 13:19:39 +02:00
parent bd2845adf6
commit 7d013eb2b6
29 changed files with 57 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/auto_init/auto_init.c
View File

@ -7,7 +7,7 @@
* General Public License v2.1. See the file LICENSE in the top level * General Public License v2.1. See the file LICENSE in the top level
* directory for more details. * directory for more details.
* *
* @ingroup auto_init * @ingroup sys_autoinit
* @{ * @{
* @file * @file
* @brief initializes any used module that has a trivial init function * @brief initializes any used module that has a trivial init function

2
sys/auto_init/can/auto_init_can.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup auto_init * @ingroup sys_autoinit
* @{ * @{
* @file * @file
* @brief initializes can device init function * @brief initializes can device init function

2
sys/auto_init/can/auto_init_can_native.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup auto_init * @ingroup sys_autoinit
* @{ * @{
* @file * @file
* @brief initializes native can device * @brief initializes native can device

2
sys/base64/base64.c
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup base64 * @ingroup sys_base64
* @{ * @{
* @file * @file
* @brief Functions to encode and decode base64 * @brief Functions to encode and decode base64

2
sys/crypto/modes/cbc.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_crypto_modes * @ingroup sys_crypto
* @{ * @{
* *
* @file * @file

2
sys/crypto/modes/ccm.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_crypto_modes * @ingroup sys_crypto
* @{ * @{
* *
* @file * @file

2
sys/crypto/modes/ctr.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_crypto_modes * @ingroup sys_crypto
* @{ * @{
* *
* @file * @file

2
sys/crypto/modes/ecb.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_crypto_modes * @ingroup sys_crypto
* @{ * @{
* *
* @file * @file

2
sys/div/div.c
View File

@ -5,7 +5,7 @@
* General Public License v2.1. See the file LICENSE in the top level * General Public License v2.1. See the file LICENSE in the top level
* directory for more details. * directory for more details.
* *
* @ingroup sys_util * @ingroup sys_div
* @{ * @{
* @file * @file
* @brief Integer division function implementations * @brief Integer division function implementations

2
sys/fs/devfs/auto_init_devfs.c
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup auto_init_fs * @ingroup sys_autoinit
* @{ * @{
* *
* @file * @file

1
sys/include/crypto/modes/cbc.h
View File

@ -70,3 +70,4 @@ int cipher_decrypt_cbc(cipher_t *cipher, uint8_t iv[16], const uint8_t *input,
#endif #endif
#endif /* CRYPTO_MODES_CBC_H */ #endif /* CRYPTO_MODES_CBC_H */
/** @} */

16
sys/include/crypto/modes/ccm.h
View File

@ -26,11 +26,16 @@
extern "C" { extern "C" {
#endif #endif
#define CCM_ERR_INVALID_NONCE_LENGTH -2 /**
#define CCM_ERR_INVALID_CBC_MAC -3 * @name CCM error codes
#define CCM_ERR_INVALID_DATA_LENGTH -3 * @{
#define CCM_ERR_INVALID_LENGTH_ENCODING -4 */
#define CCM_ERR_INVALID_MAC_LENGTH -5 #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. * @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
#endif /* CRYPTO_MODES_CCM_H */ #endif /* CRYPTO_MODES_CCM_H */
/** @} */

1
sys/include/crypto/modes/ctr.h
View File

@ -71,3 +71,4 @@ int cipher_decrypt_ctr(cipher_t* cipher, uint8_t nonce_counter[16],
#endif #endif
#endif /* CRYPTO_MODES_CTR_H */ #endif /* CRYPTO_MODES_CTR_H */
/** @} */

1
sys/include/crypto/modes/ecb.h
View File

@ -60,3 +60,4 @@ int cipher_decrypt_ecb(cipher_t* cipher, uint8_t* input, size_t length,
#endif #endif
#endif /* CRYPTO_MODES_ECB_H */ #endif /* CRYPTO_MODES_ECB_H */
/** @} */

2
sys/include/net/nanocoap_sock.h
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_net_nanocoap * @ingroup net_nanocoap
* *
* @{ * @{
* *

11
sys/include/shell_commands.h
View File

@ -7,7 +7,8 @@
*/ */
/** /**
* @ingroup sys_shell_commands * @defgroup sys_shell_commands Shell commands
* @ingroup sys
* *
* @{ * @{
* *
@ -26,12 +27,20 @@
extern "C" { extern "C" {
#endif #endif
/**
* @name Disk manipulation command names
* @{
*/
#define DISK_GET_SECTOR_SIZE "dget_ssize" #define DISK_GET_SECTOR_SIZE "dget_ssize"
#define DISK_GET_SECTOR_COUNT "dget_scount" #define DISK_GET_SECTOR_COUNT "dget_scount"
#define DISK_GET_BLOCK_SIZE "dget_bsize" #define DISK_GET_BLOCK_SIZE "dget_bsize"
#define DISK_READ_SECTOR_CMD "dread_sec" #define DISK_READ_SECTOR_CMD "dread_sec"
#define DISK_READ_BYTES_CMD "dread" #define DISK_READ_BYTES_CMD "dread"
/** @} */
/**
* @brief List of shell commands
*/
extern const shell_command_t _shell_command_list[]; extern const shell_command_t _shell_command_list[];
#ifdef __cplusplus #ifdef __cplusplus

2
sys/net/application_layer/nanocoap/nanocoap.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_net_nanocoap * @ingroup net_nanocoap
* @{ * @{
* *
* @file * @file

2
sys/net/application_layer/nanocoap/sock.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup sys_net_nanocoap * @ingroup net_nanocoap
* @{ * @{
* *
* @file * @file

2
sys/net/gnrc/pktdump/gnrc_pktdump.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup net_pktdump * @ingroup net_gnrc_pktdump
* @{ * @{
* *
* @file * @file

2
sys/net/gnrc/routing/rpl/gnrc_rpl_auto_init.c
View File

@ -8,7 +8,7 @@
*/ */
/* /*
* @ingroup gnrc_rpl * @ingroup net_gnrc_rpl
* @{ * @{
* *
* @file * @file

2
sys/net/gnrc/routing/rpl/gnrc_rpl_of_manager.c
View File

@ -10,7 +10,7 @@
/** /**
* *
* @ingroup rpl * @ingroup net_gnrc_rpl
* @{ * @{
* @file * @file
* @brief RPL Objective functions manager * @brief RPL Objective functions manager

1
sys/net/transport_layer/tcp/tcp_hdr_print.c
View File

@ -7,6 +7,7 @@
*/ */
/** /**
* @ingroup net_tcp
* @{ * @{
* *
* @file * @file

2
sys/net/transport_layer/udp/udp_hdr_print.c
View File

@ -7,7 +7,7 @@
*/ */
/** /**
* @ingroup net_pktdump * @ingroup net_udp
* @{ * @{
* *
* @file * @file

4
sys/newlib_syscalls_default/syscalls.c
View File

@ -8,7 +8,9 @@
*/ */
/** /**
* @ingroup sys_newlib * @defgroup sys_newlib Newlib system call
* @ingroup sys
* @brief Newlib system call
* @{ * @{
* *
* @file * @file

5
sys/posix/time/posix_time.c
View File

@ -4,8 +4,11 @@
* This file is subject to the terms and conditions of the GNU Lesser * 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 * General Public License v2.1. See the file LICENSE in the top level
* directory for more details. * directory for more details.
*/
/**
* @ingroup sys_xtimer
* *
* @ingroup xtimer
* @{ * @{
* @file * @file
* @brief xtimer posix wrapper * @brief xtimer posix wrapper

2
sys/ps/ps.c
View File

@ -7,7 +7,7 @@
* General Public License v2.1. See the file LICENSE in the top level * General Public License v2.1. See the file LICENSE in the top level
* directory for more details. * directory for more details.
* *
* @ingroup ps * @ingroup sys_ps
* @{ * @{
* @file * @file
* @brief UNIX like ps command * @brief UNIX like ps command

2
sys/shell/commands/sc_gnrc_rpl.c
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* @ingroup sys_shell_commands.h * @ingroup sys_shell_commands
* @{ * @{
* *
* @file * @file

3
sys/xtimer/xtimer.c
View File

@ -8,7 +8,8 @@
*/ */
/** /**
* @ingroup xtimer * @ingroup sys_xtimer
*
* @{ * @{
* @file * @file
* @brief xtimer convenience functionality * @brief xtimer convenience functionality

5
sys/xtimer/xtimer_core.c
View File

@ -5,8 +5,11 @@
* This file is subject to the terms and conditions of the GNU Lesser * 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 * General Public License v2.1. See the file LICENSE in the top level
* directory for more details. * directory for more details.
*/
/**
* @ingroup sys_xtimer
* *
* @ingroup xtimer
* @{ * @{
* @file * @file
* @brief xtimer core functionality * @brief xtimer core functionality