diff --git a/connectivity/FEATURE_BLE/include/ble/BLE.h b/connectivity/FEATURE_BLE/include/ble/BLE.h index e1966b9b51..1916996e6f 100644 --- a/connectivity/FEATURE_BLE/include/ble/BLE.h +++ b/connectivity/FEATURE_BLE/include/ble/BLE.h @@ -475,6 +475,11 @@ private: bool event_signaled; }; + +/** + * @} + */ + } using ble::BLE; @@ -482,8 +487,4 @@ using ble::BLE; * @namespace ble Entry namespace for all BLE API definitions. */ -/** - * @} - */ - #endif /* ifndef MBED_BLE_H__ */ diff --git a/connectivity/FEATURE_BLE/include/ble/common/blecommon.h b/connectivity/FEATURE_BLE/include/ble/common/blecommon.h index fcd99fd734..1b6d6a695e 100644 --- a/connectivity/FEATURE_BLE/include/ble/common/blecommon.h +++ b/connectivity/FEATURE_BLE/include/ble/common/blecommon.h @@ -24,7 +24,8 @@ extern "C" { #endif /** - * @addtogroup ble + * @defgroup ble Bluetooth + * @ingroup connectivity-public-api * @{ * @addtogroup common * @{ diff --git a/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/controller/include/common/bb_api.h b/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/controller/include/common/bb_api.h index 067f7f639e..27486cdadd 100644 --- a/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/controller/include/common/bb_api.h +++ b/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/controller/include/common/bb_api.h @@ -397,7 +397,7 @@ uint32_t BbGetTargetTimeDelta(uint32_t targetUsec, uint32_t refUsec); /*************************************************************************************************/ uint8_t BbGetActiveProtocol(void); -/*! \} */ /* BB_API_CTRL */ +/*! \} */ /* BB_API_CTRL */ #ifdef __cplusplus }; diff --git a/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h b/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h index 35421d23ad..d0428bab20 100644 --- a/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h +++ b/connectivity/FEATURE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h @@ -1,4 +1,4 @@ -/** +/* * Copyright (c) 2014 - 2019, Nordic Semiconductor ASA * * All rights reserved. @@ -37,6 +37,7 @@ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ + #ifndef BOARDS_H #define BOARDS_H @@ -92,7 +93,8 @@ extern "C" { #endif -/**@defgroup BSP_BOARD_INIT_FLAGS Board initialization flags. +/** + * @defgroup BSP_BOARD_INIT_FLAGS Board initialization flags. * @{ */ #define BSP_INIT_NONE 0 /**< No initialization of LEDs or buttons (@ref bsp_board_init).*/ #define BSP_INIT_LEDS (1 << 0) /**< Enable LEDs during initialization (@ref bsp_board_init).*/ diff --git a/connectivity/cellular/include/CellularNonIPSocket.h b/connectivity/cellular/include/CellularNonIPSocket.h index 0d206aec3c..a76877f38a 100644 --- a/connectivity/cellular/include/CellularNonIPSocket.h +++ b/connectivity/cellular/include/CellularNonIPSocket.h @@ -29,7 +29,7 @@ namespace mbed { -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /** Socket implementation for cellular Non-IP data delivery(NIDD). diff --git a/connectivity/cellular/include/cellular/framework/API/CellularContext.h b/connectivity/cellular/include/cellular/framework/API/CellularContext.h index 8281b1c25e..254a61b97a 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularContext.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularContext.h @@ -32,7 +32,12 @@ namespace mbed { /** - * @addtogroup cellular + * @defgroup connectivity-public-api Connectivity + * @ingroup mbed-os-public + * @{ + + * @defgroup Cellular + * @ingroup connectivity-public-api * @{ */ @@ -396,6 +401,7 @@ protected: }; /** + * @} * @} */ diff --git a/connectivity/cellular/include/cellular/framework/API/CellularDevice.h b/connectivity/cellular/include/cellular/framework/API/CellularDevice.h index 1fa2e2f855..f97d5829af 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularDevice.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularDevice.h @@ -43,7 +43,7 @@ const int MAX_PLMN_SIZE = 16; const int MAX_SIM_READY_WAITING_TIME = 30; /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ diff --git a/connectivity/cellular/include/cellular/framework/API/CellularInformation.h b/connectivity/cellular/include/cellular/framework/API/CellularInformation.h index e68d96cc58..c4433a1ad8 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularInformation.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularInformation.h @@ -27,7 +27,7 @@ const int MAX_ICCID_LENGTH = 20 + 1; // +1 for zero termination namespace mbed { /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ diff --git a/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h b/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h index a8894c79d0..44a0aca89e 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularNetwork.h @@ -31,7 +31,7 @@ const int MAX_OPERATOR_NAME_LONG = 16; const int MAX_OPERATOR_NAME_SHORT = 8; /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ diff --git a/connectivity/cellular/include/cellular/framework/API/CellularSMS.h b/connectivity/cellular/include/cellular/framework/API/CellularSMS.h index 0e0be51ede..c1e42ebed8 100644 --- a/connectivity/cellular/include/cellular/framework/API/CellularSMS.h +++ b/connectivity/cellular/include/cellular/framework/API/CellularSMS.h @@ -38,7 +38,7 @@ const uint16_t SMS_SIM_WAIT_TIME_MILLISECONDS = 200; const int SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ = -5001; /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularContext.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularContext.h index b1d8985a9c..d30709954b 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularContext.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularContext.h @@ -22,10 +22,17 @@ #include "rtos/Semaphore.h" #include "AT_CellularDevice.h" + const int MAX_APN_LENGTH = 63 + 1; namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + class AT_CellularContext : public CellularContext { public: AT_CellularContext(ATHandler &at, CellularDevice *device, const char *apn = 0, bool cp_req = false, bool nonip_req = false); @@ -141,6 +148,10 @@ protected: ATHandler &_at; }; +/** + * @} + */ + } // namespace mbed #endif // AT_CELLULARCONTEXT_H_ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularDevice.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularDevice.h index 07a5f90dad..2c5c2ee91b 100755 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularDevice.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularDevice.h @@ -23,6 +23,12 @@ namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + class AT_CellularInformation; class AT_CellularNetwork; class AT_CellularSMS; @@ -202,5 +208,9 @@ private: const intptr_t *_property_array; }; +/** + * @} + */ + } // namespace mbed #endif // AT_CELLULAR_DEVICE_H_ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularInformation.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularInformation.h index 5966bede5f..9d3907a55f 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularInformation.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularInformation.h @@ -22,8 +22,15 @@ #include "ATHandler.h" #include "AT_CellularDevice.h" + namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + /** * Class AT_CellularInformation * @@ -63,6 +70,10 @@ protected: AT_CellularDevice &_device; }; +/** + * @} + */ + } // namespace mbed #endif // AT_CELLULAR_INFORMATION_H_ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularNetwork.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularNetwork.h index 7fde25973a..3a4fa56442 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularNetwork.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularNetwork.h @@ -22,8 +22,15 @@ #include "ATHandler.h" #include "AT_CellularDevice.h" + namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + #define AT_NETWORK_TRIALS 5 #define TIMER_UNIT_LENGTH 3 #define TWO_BYTES_HEX 4 @@ -148,6 +155,10 @@ protected: AT_CellularDevice &_device; }; +/** + * @} + */ + } // namespace mbed #endif // AT_CELLULAR_NETWORK_H_ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularSMS.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularSMS.h index 53fd823c89..74751092ab 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularSMS.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularSMS.h @@ -26,8 +26,15 @@ #include "AT_CellularDevice.h" #include + namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + /** * Class AT_CellularSMS * @@ -171,6 +178,10 @@ private: AT_CellularDevice &_device; }; +/** + * @} + */ + } // namespace mbed #endif //MBED_CONF_CELLULAR_USE_SMS diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_CellularStack.h b/connectivity/cellular/include/cellular/framework/AT/AT_CellularStack.h index dac4827c9f..b306a018bb 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_CellularStack.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_CellularStack.h @@ -23,8 +23,15 @@ #include "rtos/Mutex.h" #include "AT_CellularDevice.h" + namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + // and : each is a string type that identifies the MT in the address space applicable to the PDP. // The string is given as dot-separated numeric (0-255) parameter of the form: // a1.a2.a3.a4 for IPv4 and @@ -215,6 +222,10 @@ protected: AT_CellularDevice &_device; }; +/** + * @} + */ + } // namespace mbed #endif // AT_CELLULAR_STACK_H_ diff --git a/connectivity/cellular/include/cellular/framework/AT/AT_ControlPlane_netif.h b/connectivity/cellular/include/cellular/framework/AT/AT_ControlPlane_netif.h index b9c1effc06..a4082d59af 100644 --- a/connectivity/cellular/include/cellular/framework/AT/AT_ControlPlane_netif.h +++ b/connectivity/cellular/include/cellular/framework/AT/AT_ControlPlane_netif.h @@ -20,8 +20,15 @@ #include "ATHandler.h" #include "AT_CellularDevice.h" + namespace mbed { +/** + * @addtogroup at-hayes AT/Hayes Command Set + * @ingroup Cellular + * @{ + */ + class AT_ControlPlane_netif: public ControlPlane_netif { public: AT_ControlPlane_netif(ATHandler &at, int cid, AT_CellularDevice &device); @@ -63,4 +70,8 @@ protected: AT_CellularDevice &_device; }; +/** + * @} + */ + } //mbed namespace diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm.h index ccf073208f..b5e2fde14e 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm.h @@ -52,10 +52,6 @@ extern "C" @file @brief This file contains all of the enums and definitions that are used for the CRYS AESCCM APIs, as well as the APIs themselves. The API supports AES-CCM and AES-CCM* as defined in ieee-802.15.4. -@defgroup crys_aesccm CryptoCell AES-CCM APIs -@{ -@ingroup cryptocell_api - @note Regarding the AES-CCM*, the API supports only AES-CCM* as defined in ieee-802.15.4-2011; With the instantiations as defined in B.3.2 and the nonce as defined in 7.3.2. @@ -307,9 +303,5 @@ CRYSError_t CRYS_AESCCMStar_NonceGenerate( } #endif -/** -@} - */ - #endif /*#ifndef CRYS_AESCCM_H*/ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm_error.h index 4ed26e312b..d1c600abe3 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm_error.h @@ -49,9 +49,7 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS AESCCM errors. -@defgroup crys_aesccm_error CryptoCell AES-CCM specific errors -@{ -@ingroup crys_aesccm + */ /************************ Defines ******************************/ @@ -125,10 +123,4 @@ extern "C" } #endif -/** -@} - */ - -#endif - - +#endif \ No newline at end of file diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha.h index 89fb88d239..f3b715d215 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha.h @@ -37,9 +37,7 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS CHACHA APIs, as well as the APIs themselves. -@defgroup crys_chacha CryptoCell CHACHA APIs -@{ -@ingroup cryptocell_api + */ #ifndef CRYS_CHACHA_H #define CRYS_CHACHA_H @@ -222,10 +220,6 @@ CIMPORT_C CRYSError_t CRYS_CHACHA( } #endif -/** -@} - */ - #endif /* #ifndef CRYS_CHACHA_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_error.h index 93f6141a21..d4e0ad572d 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_error.h @@ -47,9 +47,7 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS CHACHA errors. -@defgroup crys_chacha_error CryptoCell CHACHA specific errors -@{ -@ingroup crys_chacha + */ @@ -95,9 +93,7 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ + #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly.h index f9a7ce15fa..0f59088e93 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS CHACHA-POLY APIs, as well as the APIs themselves. -@defgroup crys_chacha_poly CryptoCell CHACHA-POLY APIs -@{ -@ingroup cryptocell_api */ #ifndef CRYS_CHACHA_POLY_H #define CRYS_CHACHA_POLY_H @@ -84,12 +81,4 @@ CIMPORT_C CRYSError_t CRYS_CHACHA_POLY( #ifdef __cplusplus } #endif -/** -@} - */ -#endif /* #ifndef CRYS_CHACHA_POLY_H */ - - - - - +#endif /* #ifndef CRYS_CHACHA_POLY_H */ \ No newline at end of file diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly_error.h index f5465ecfac..8594eec098 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha_poly_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS CHACHA POLY errors. -@defgroup crys_chacha_poly_error CryptoCell CHACHA POLY specific errors -@{ -@ingroup crys_chacha_poly */ @@ -87,9 +84,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh.h index be0deb907c..b50a39ebad 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh.h @@ -51,9 +51,6 @@ extern "C" /*! @file @brief This module defines the API that supports Diffie-Hellman key exchange, as defined in [PKCS3] and in [X9.42] (key lengths 1024 and 2048 bits). -@defgroup crys_dh CryptoCell DH APIs -@{ -@ingroup cryptocell_api */ @@ -440,7 +437,4 @@ CIMPORT_C CRYSError_t CRYS_DH_CheckPubKey( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_error.h index c9a7ff6800..cc9bfb0558 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_error.h @@ -49,9 +49,6 @@ extern "C" /*! @file @brief This file contains error codes definitions for CRYS DH module. -@defgroup crys_dh_error CryptoCell DH specific errors -@{ -@ingroup crys_dh */ /************************ Defines ******************************/ /* DH module on the CRYS layer base address - 0x00F00500 */ @@ -151,8 +148,5 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_kg.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_kg.h index 15654288f9..15a7ea6352 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_kg.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_dh_kg.h @@ -49,9 +49,6 @@ extern "C" /*! @file @brief This module defines the API that supports Diffie-Hellman domain. -@defgroup crys_dh_kg CryptoCell DH Key Generation APIs -@{ -@ingroup crys_dh */ /************************ Defines ******************************/ @@ -197,7 +194,4 @@ CIMPORT_C CRYSError_t CRYS_DH_CheckDomainParams( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_edw_api.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_edw_api.h index 6d54471307..22ccdbea6f 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_edw_api.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_edw_api.h @@ -47,17 +47,11 @@ extern "C" { #endif /*! -@defgroup cryptocell_ec CryptoCell EC 25519 curve APIs -@{ -@ingroup cryptocell_api @brief This group is the cryptocell EC 25519 curve root group @} @file @brief This file contains the CRYS APIs used for EC EDW (Edwards) ed25519 algorithms. -@defgroup crys_ec_edw CryptoCell EC Edwards APIs -@{ -@ingroup cryptocell_ec \note Algorithms of Montgomery and Edwards elliptic curves cryptography were developed by Daniel.J.Bernstein. @@ -192,9 +186,6 @@ CIMPORT_C CRYSError_t CRYS_ECEDW_KeyPair ( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_api.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_api.h index 57ab9d78ba..b16390e46a 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_api.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_api.h @@ -48,9 +48,6 @@ extern "C" { /*! @file @brief This file contains the CRYS APIs used for EC MONT (Montgomery Curve25519) algorithms. -@defgroup crys_ec_mont CryptoCell EC Montgomery APIs -@{ -@ingroup cryptocell_ec \note Implemented algorithms according to Montgomery elliptic curves cryptography, @@ -204,9 +201,6 @@ CIMPORT_C CRYSError_t CRYS_ECMONT_SeedKeyPair ( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_edw_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_edw_error.h index 5b76d2cc40..f12a73db11 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_edw_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ec_mont_edw_error.h @@ -39,9 +39,6 @@ /*! @file @brief This module containes the definitions of the CRYS ECC-25519 errors. -@defgroup crys_ecmontedw_error CryptoCell ECC-25519 errors -@{ -@ingroup cryptocell_ec */ #include "crys_error.h" diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_build.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_build.h index 72391ab710..609501e471 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_build.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_build.h @@ -37,17 +37,11 @@ #define CRYS_ECPKI_BUILD_H /*! -@defgroup cryptocell_ecpki CryptoCell ECC APIs -@{ -@ingroup cryptocell_api @brief This group is the cryptocell ECC root group @} @file @brief This module defines functions for building key structures used in Elliptic Curves Cryptography (ECC). -@defgroup crys_ecpki_build CryptoCell key build for ECC APIs -@{ -@ingroup cryptocell_ecpki */ @@ -201,7 +195,4 @@ CIMPORT_C CRYSError_t CRYS_ECPKI_ExportPublKey( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_dh.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_dh.h index b95abe55e7..d79507035d 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_dh.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_dh.h @@ -39,9 +39,6 @@ /*! @file @brief Defines the API that supports EC Diffie-Hellman shared secret value derivation primitives. -@defgroup crys_ecpki_dh CryptoCell ECC Diffie-Hellman APIs -@{ -@ingroup cryptocell_ecpki */ @@ -84,7 +81,4 @@ CIMPORT_C CRYSError_t CRYS_ECDH_SVDP_DH( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_domain.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_domain.h index 8475d522e5..f6041b4fc5 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_domain.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_domain.h @@ -41,9 +41,6 @@ /*! @file @brief Defines the ecpki build domain API. -@defgroup crys_ecpki_domain CryptoCell ECC domain APIs -@{ -@ingroup cryptocell_ecpki */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_ecdsa.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_ecdsa.h index 02db31d948..d9ee42c869 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_ecdsa.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_ecdsa.h @@ -40,9 +40,6 @@ /*! @file @brief Defines the APIs that support the ECDSA functions. -@defgroup crys_ecpki_ecdsa CryptoCell ECDSA APIs -@{ -@ingroup cryptocell_ecpki */ #include "crys_error.h" @@ -133,7 +130,4 @@ CIMPORT_C CRYSError_t CRYS_ECDSA_Verify ( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_error.h index 9eb141dc56..d47a132811 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_error.h @@ -41,9 +41,6 @@ /*! @file @brief This module contains the definitions of the CRYS ECPKI errors. -@defgroup crys_ecpki_error CryptoCell ECC specific errors -@{ -@ingroup cryptocell_ecpki */ #include "crys_error.h" @@ -295,9 +292,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_kg.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_kg.h index 10fcd49ab3..8675735044 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_kg.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_kg.h @@ -39,9 +39,6 @@ /*! @file @brief Defines the API for generation of ECC private and public keys. -@defgroup crys_ecpki_kg CryptoCell ECC Key Generation APIs -@{ -@ingroup cryptocell_ecpki */ @@ -78,9 +75,6 @@ CIMPORT_C CRYSError_t CRYS_ECPKI_GenKeyPair( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_types.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_types.h index 2b4ee2c646..1de305856e 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_types.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_ecpki_types.h @@ -40,9 +40,6 @@ /*! @file @brief Contains all of the enums and definitions that are used for the CRYS ECPKI APIs. -@defgroup crys_ecpki_types CryptoCell ECC specific types -@{ -@ingroup cryptocell_ecpki */ #include "ssi_pal_types_plat.h" @@ -472,7 +469,4 @@ typedef struct CRYS_ECDHFipsKatContext_t{ #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_error.h index ae9125e7a9..b17f74b62b 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_error.h @@ -46,9 +46,6 @@ extern "C" /*! @file @brief This module defines the error return code types and the numbering spaces of the error codes for each module of the layers listed below. -@defgroup crys_error CryptoCell general base error codes -@{ -@ingroup cryptocell_api */ /*! The definitions of the error number space used for the different modules */ @@ -263,9 +260,6 @@ typedef uint32_t CRYSError_t; #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash.h index ea93a8a861..5b89b83130 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS HASH APIs, as well as the APIs themselves. -@defgroup crys_hash CryptoCell HASH APIs -@{ -@ingroup cryptocell_api This product supports the following HASH algorithms (or modes, according to product): @@ -279,7 +276,4 @@ CIMPORT_C CRYSError_t CRYS_HASH ( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_defs.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_defs.h index 701f78a870..8841d96fdc 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_defs.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_defs.h @@ -39,9 +39,6 @@ /*! @file @brief This file contains HASH definitions. -@defgroup crys_hash_defs CryptoCell Hash definitions -@{ -@ingroup crys_hash */ #ifdef __cplusplus diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_error.h index 3840d183f7..50c742cfa8 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hash_error.h @@ -49,9 +49,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS HASH errors. -@defgroup crys_hash_error CryptoCell HASH specific errors -@{ -@ingroup crys_hash */ @@ -100,9 +97,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf.h index fbc5bcc555..2517dd8835 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf.h @@ -46,9 +46,6 @@ extern "C" /*! @file @brief This module defines the API that supports HMAC Key derivation function as defined by RFC5869. -@defgroup crys_hkdf CryptoCell HMAC Key Derivation APIs -@{ -@ingroup cryptocell_api */ /*! HKDF maximal key size in words. */ @@ -117,8 +114,5 @@ CEXPORT_C CRYSError_t CRYS_HKDF_KeyDerivFunc( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf_error.h index d78398e32f..f33e744c1c 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hkdf_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS HKDF errors. -@defgroup crys_hkdf_error HMAC Key Derivation specific errors -@{ -@ingroup crys_hkdf */ @@ -81,9 +78,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac.h index 9094d732ef..c3c42ae994 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS HMAC APIs, as well as the APIs themselves. -@defgroup crys_hmac CryptoCell HMAC APIs -@{ -@ingroup cryptocell_api HMAC is a wrapping algorithm that uses a HASH function (one of the supported HASH algorithms, as specified in the HASH chapter) and a key, @@ -208,7 +205,4 @@ CIMPORT_C CRYSError_t CRYS_HMAC ( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_defs.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_defs.h index 6e76d71988..491e36aa19 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_defs.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_defs.h @@ -45,9 +45,6 @@ extern "C" /*! @file @brief This file contains HMAC definitions. -@defgroup crys_hmac_defs CryptoCell Hmac definitions -@{ -@ingroup crys_hmac */ /************************ Defines ******************************/ @@ -58,7 +55,4 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_error.h index e9bd5c8b2f..9e1193c4cf 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_hmac_error.h @@ -46,9 +46,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS HMAC errors. -@defgroup crys_hmac_error CryptoCell HMAC specific errors -@{ -@ingroup crys_hmac */ @@ -100,9 +97,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf.h index add338e2f3..49780f68f9 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf.h @@ -48,9 +48,6 @@ extern "C" @file @brief This module defines the API that supports Key derivation function in modes as defined in PKCS#3, ANSI X9.42-2001, and ANSI X9.63-1999. -@defgroup crys_kdf CryptoCell Key Derivation APIs -@{ -@ingroup cryptocell_api */ #include "crys_hash.h" @@ -204,8 +201,5 @@ CIMPORT_C CRYSError_t CRYS_KDF_KeyDerivFunc( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf_error.h index 905ffa1a40..eb537ce3df 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_kdf_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS KDF errors. -@defgroup crys_kdf_error CryptoCell Key Derivation specific errors -@{ -@ingroup crys_kdf */ @@ -95,9 +92,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_pka_defs_hw.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_pka_defs_hw.h index 5073ad2e4f..b56e9eda1a 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_pka_defs_hw.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_pka_defs_hw.h @@ -42,17 +42,11 @@ #include "ssi_pka_hw_plat_defs.h" /*! -@defgroup cryptocell_pka CryptoCell PKA group -@{ -@ingroup cryptocell_api @brief This group is the cryptocell PKA root group @} @file @brief The file contains all of the enums and definitions that are used in the PKA related code. -@defgroup crys_pka_defs_hw CryptoCell PKA specific definitions -@{ -@ingroup cryptocell_pka */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly.h index 7c5f218838..739ed762d0 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS POLY APIs, as well as the APIs themselves. -@defgroup crys_poly CryptoCell POLY APIs -@{ -@ingroup cryptocell_api */ #ifndef CRYS_POLY_H @@ -96,9 +93,6 @@ CIMPORT_C CRYSError_t CRYS_POLY( #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef CRYS_POLY_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly_error.h index 0b8989212b..cc27a6fe2d 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_poly_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS POLY errors. -@defgroup crys_poly_error CryptoCell POLY specific errors -@{ -@ingroup crys_poly */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd.h index 12ba8ec0e3..df66661a16 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd.h @@ -50,9 +50,6 @@ extern "C" @file @brief This file contains the CRYS APIs used for random number generation. The random-number generation module implements referenced standard [SP800-90]. -@defgroup crys_rnd CryptoCell Random Generator APIs -@{ -@ingroup cryptocell_api */ /************************ Defines ******************************/ @@ -373,8 +370,5 @@ CIMPORT_C void CRYS_RND_DisableKatMode( #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef CRYS_RND_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd_error.h index a38f3bc0de..2c3022a909 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rnd_error.h @@ -49,9 +49,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS RND errors. -@defgroup crys_rnd_error CryptoCell RND specific errors -@{ -@ingroup crys_rnd */ @@ -145,9 +142,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_build.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_build.h index c522aa3fd3..16b98f3ed9 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_build.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_build.h @@ -47,17 +47,11 @@ extern "C" #endif /*! -@defgroup crys_rsa CryptoCell RSA APIs -@{ -@ingroup cryptocell_api @brief This group is the cryptocell ECC root group @} @file @brief This module defines some utility functions for working with RSA cryptography. -@defgroup crys_rsa_build CryptoCell RSA Utility APIs -@{ -@ingroup crys_rsa */ /******************************************************************************************/ @@ -146,7 +140,4 @@ CIMPORT_C CRYSError_t CRYS_RSA_Get_PubKey( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_error.h index a8468ff3d9..4c7b34409b 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS RSA errors. -@defgroup crys_rsa_error CryptoCell RSA specific errors -@{ -@ingroup crys_rsa */ /************************ Defines ******************************/ @@ -269,9 +266,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_kg.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_kg.h index 401fb2ec5f..26e879b90b 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_kg.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_kg.h @@ -49,9 +49,6 @@ extern "C" /*! @file @brief Generates a RSA pair of public and private keys. -@defgroup crys_rsa_kg CryptoCell RSA key generation APIs -@{ -@ingroup crys_rsa */ /************************ Defines ******************************/ @@ -121,9 +118,6 @@ CIMPORT_C CRYSError_t CRYS_RSA_KG_GenerateKeyPairCRT( #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_prim.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_prim.h index 2d2c3b4956..9f4c0dddbc 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_prim.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_prim.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module defines the API that implements the [PKCS1_2.1] primitive functions. -@defgroup crys_rsa_prim CryptoCell RSA primitive APIs -@{ -@ingroup crys_rsa \note Direct use of primitive functions, rather than schemes to protect data, is strongly discouraged as primitive functions are @@ -119,7 +116,4 @@ since the signature primitive is identical to the decryption primitive. #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_schemes.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_schemes.h index ab35620534..99520f49ce 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_schemes.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_schemes.h @@ -50,9 +50,6 @@ extern "C" /*! @file @brief This module defines APIs that support [PKCS1_1.5] and [PKCS1_2.1] encryption and signature schemes. -@defgroup crys_rsa_schemes CryptoCell RSA encryption and signature schemes -@{ -@ingroup crys_rsa */ /**********************************************************************************************************/ @@ -515,7 +512,4 @@ it assumes the DataIn_ptr has already been hashed using SHA512. #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_types.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_types.h index 4a47c37dcf..6480fbba7e 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_types.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_rsa_types.h @@ -53,9 +53,6 @@ extern "C" /*! @file @brief This file contains all of the enums and definitions that are used for the CRYS RSA APIs. -@defgroup crys_rsa_types CryptoCell RSA used definitions and enums -@{ -@ingroup crys_rsa */ /************************ Defines ******************************/ @@ -610,7 +607,4 @@ typedef struct CRYS_RSAFipsKatContext_t{ #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp.h index 20ca556e7f..9b389584f9 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CRYS SRP APIs, as well as the APIs themselves. -@defgroup crys_srp CryptoCell SRP APIs -@{ -@ingroup cryptocell_api */ #ifndef CRYS_SRP_H @@ -364,9 +361,6 @@ CIMPORT_C CRYSError_t CRYS_SRP_UserProofVerify( #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef CRYS_SRP_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp_error.h index a710746d0f..5eab0802bb 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_srp_error.h @@ -47,9 +47,6 @@ extern "C" /*! @file @brief This module contains the definitions of the CRYS SRP errors. -@defgroup crys_srp_error CryptoCell SRP specific errors -@{ -@ingroup crys_srp */ @@ -83,9 +80,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/sns_silib.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/sns_silib.h index 6a1502afbd..50f2f6d563 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/sns_silib.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/sns_silib.h @@ -37,9 +37,6 @@ @file @brief This file contains all of the enums and definitions that are used for the CryptoCell Lib init and finish APIs, as well as the APIs themselves. -@defgroup sns_silib CryptoCell library basic APIs -@{ -@ingroup cryptocell_api */ @@ -106,8 +103,5 @@ SA_SilibRetCode_t SaSi_LibFini(void *rnd_ctx /*!< [in/out] Pointer to the RND #ifdef __cplusplus } #endif -/** -@} - */ #endif /*__DX_CCLIB_H__*/ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes.h index ccd50abb53..69943e4b2f 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes.h @@ -36,9 +36,6 @@ /*! @file @brief This file contains all of the enums and definitions that are used for the CryptoCell AES APIs, as well as the APIs themselves. -@defgroup ssi_aes CryptoCell AES APIs -@{ -@ingroup cryptocell_api */ #ifndef SSI_AES_H @@ -318,8 +315,5 @@ CIMPORT_C SaSiError_t SaSi_AesFree( #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef SSI_AES_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_defs.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_defs.h index 02789d068c..6dad361b83 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_defs.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_defs.h @@ -36,9 +36,6 @@ /*! @file @brief This file contains definitions that are used for the ARM CryptoCell 3xx version of the CryptoCell AES APIs. -@defgroup ssi_aes_defs CryptoCell AES definitions -@{ -@ingroup ssi_aes */ @@ -77,7 +74,4 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef SSI_AES_DEFS_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_error.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_error.h index 4ad49e6090..48ad2b7bc4 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_error.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_aes_error.h @@ -36,9 +36,6 @@ /*! @file @brief This file contains the definitions of the CryptoCell AES errors. -@defgroup ssi_aes_error CryptoCell AES specific errors -@{ -@ingroup ssi_aes */ #ifndef SSI_AES_ERROR_H @@ -127,7 +124,4 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif /* #ifndef SSI_AES_ERROR_H */ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_compiler.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_compiler.h index 9481d63314..742791235c 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_compiler.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_compiler.h @@ -39,9 +39,6 @@ /*! @file @brief This file contains compiler related definitions. -@defgroup ssi_pal_compiler CryptoCell PAL platform dependant compiler specific definitions -@{ -@ingroup ssi_pal */ @@ -182,7 +179,4 @@ #else #error Unsupported compiler. #endif -/** -@} - */ #endif /*__SSI_PAL_COMPILER_H__*/ diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_trng.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_trng.h index 029bb0aa1a..36c1ada753 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_trng.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_trng.h @@ -58,9 +58,6 @@ SaSiError_t SaSi_PalTrngParameterGet(uint32_t *SubSamplingRatio /*!< [out] TRNG #ifdef __cplusplus } #endif -/** -@} - */ #endif diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_types.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_types.h index d2554881a1..c2dec4cd6b 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_types.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pal_types.h @@ -36,9 +36,6 @@ /*! @file @brief This file contains the platform dependent definitions and types. -@defgroup ssi_pal_types CryptoCell PAL platform dependant types -@{ -@ingroup ssi_pal */ #ifndef SSI_PAL_TYPES_H diff --git a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pka_hw_plat_defs.h b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pka_hw_plat_defs.h index c205919f5c..edf904de91 100644 --- a/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pka_hw_plat_defs.h +++ b/connectivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/ssi_pka_hw_plat_defs.h @@ -45,9 +45,6 @@ extern "C" /*! @file @brief Contains the enums and definitions that are used in the PKA code (definitions that are platform dependent). -@defgroup ssi_pka_hw_plat_defs CryptoCell PKA specific types and definitions -@{ -@ingroup cryptocell_pka */ @@ -69,9 +66,6 @@ extern "C" #ifdef __cplusplus } #endif -/** -@} - */ #endif //PKA_HW_PLAT_DEFS_H diff --git a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/aes_alt.h b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/aes_alt.h index 6b18a334e6..2fb4edebbc 100644 --- a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/aes_alt.h +++ b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/aes_alt.h @@ -19,16 +19,6 @@ #ifndef MBEDTLS_AES_ALT_H #define MBEDTLS_AES_ALT_H -/***************************************************************************//** - * \addtogroup sl_crypto - * \{ - ******************************************************************************/ - -/***************************************************************************//** - * \addtogroup sl_crypto_aes AES block cipher - * \brief Hardware accelerated AES block cipher. - * \{ - ******************************************************************************/ #if defined(MBEDTLS_AES_ALT) /* SiliconLabs CRYPTO hardware acceleration implementation */ @@ -312,7 +302,5 @@ MBEDTLS_DEPRECATED static inline void mbedtls_aes_decrypt( #endif /* MBEDTLS_AES_ALT */ -/** \} (end addtogroup sl_crypto_aes) */ -/** \} (end addtogroup sl_crypto) */ #endif /* MBEDTLS_AES_ALT_H */ diff --git a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/crypto_management.h b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/crypto_management.h index b1a4e9f151..6c062af31d 100644 --- a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/crypto_management.h +++ b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/crypto_management.h @@ -21,12 +21,6 @@ #define CRYPTO_MANAGEMENT_H /***************************************************************************//** - * \addtogroup sl_crypto - * \{ - ******************************************************************************/ - -/***************************************************************************//** - * \addtogroup sl_crypto_management CRYPTO peripheral instance management * \brief Management functions for CRYPTO peripherals. These functions take care * of not having two 'owners' simultaneously for the same peripheral, * potentially messing up the internal state of said peripheral. @@ -122,7 +116,6 @@ void crypto_management_release_preemption( CRYPTO_TypeDef *device ); #endif /* CRYPTO_PRESENT */ -/** \} (end addtogroup sl_crypto_management) */ -/** \} (end addtogroup sl_crypto) */ +/** \}*/ #endif /* CRYPTO_MANAGEMENT_H */ \ No newline at end of file diff --git a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha1_alt.h b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha1_alt.h index d17cc8b211..9c5d3d0c24 100644 --- a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha1_alt.h +++ b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha1_alt.h @@ -21,17 +21,6 @@ #ifndef MBEDTLS_SHA1_ALT_H #define MBEDTLS_SHA1_ALT_H -/***************************************************************************//** - * \addtogroup sl_crypto - * \{ - ******************************************************************************/ - -/***************************************************************************//** - * \addtogroup sl_crypto_sha1 SHA-1 cryptographic hash function - * \brief CRYPTO hardware accelerated SHA-1 cryptographic hash function. - * \{ - ******************************************************************************/ - #if defined(MBEDTLS_SHA1_ALT) #include @@ -186,7 +175,4 @@ MBEDTLS_DEPRECATED void mbedtls_sha1_process( mbedtls_sha1_context *ctx, #endif /* #if defined(MBEDTLS_SHA1_ALT) */ -/** \} (end addtogroup sl_crypto_sha1) */ -/** \} (end addtogroup sl_crypto) */ - #endif /* #ifndef MBEDTLS_SHA1_ALT_H */ diff --git a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha256_alt.h b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha256_alt.h index a7774d3569..2771ae3efc 100644 --- a/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha256_alt.h +++ b/connectivity/drivers/mbedtls/TARGET_Silicon_Labs/sha256_alt.h @@ -22,12 +22,6 @@ #define MBEDTLS_SHA256_ALT_H /***************************************************************************//** - * \addtogroup sl_crypto - * \{ - ******************************************************************************/ - -/***************************************************************************//** - * \addtogroup sl_crypto_sha256 SHA-224 and SHA-256 cryptographic hash function * \brief CRYPTO hardware accelerated SHA-224 and SHA-256 cryptographic hash function. * \{ ******************************************************************************/ @@ -181,7 +175,6 @@ MBEDTLS_DEPRECATED void mbedtls_sha256_process( mbedtls_sha256_context *ctx, #endif /* #if defined(MBEDTLS_SHA256_ALT) */ -/** \} (end addtogroup sl_crypto_sha256) */ -/** \} (end addtogroup sl_crypto) */ +/** \} */ #endif /* #ifndef MBEDTLS_SHA256_ALT_H */ diff --git a/connectivity/drivers/wifi/TARGET_STM/COMPONENT_EMW3080B/mx_wifi/mx_wifi.h b/connectivity/drivers/wifi/TARGET_STM/COMPONENT_EMW3080B/mx_wifi/mx_wifi.h index e7aba01f37..258190b793 100644 --- a/connectivity/drivers/wifi/TARGET_STM/COMPONENT_EMW3080B/mx_wifi/mx_wifi.h +++ b/connectivity/drivers/wifi/TARGET_STM/COMPONENT_EMW3080B/mx_wifi/mx_wifi.h @@ -1497,12 +1497,6 @@ int32_t MX_WIFI_FOTA_start(MX_WIFIObject_t *Obj, const char *url, const char *md */ -/** - * @} ** - */ - - - #ifdef __cplusplus } #endif /* __cplusplus */ diff --git a/connectivity/lorawan/include/lorawan/LoRaRadio.h b/connectivity/lorawan/include/lorawan/LoRaRadio.h index f6673399ac..03b02ff493 100644 --- a/connectivity/lorawan/include/lorawan/LoRaRadio.h +++ b/connectivity/lorawan/include/lorawan/LoRaRadio.h @@ -19,6 +19,7 @@ #define LORARADIO_H_ /** @addtogroup LoRaWAN + * @ingroup connectivity-public-api * Parent class for a LoRa radio driver * @{ */ diff --git a/connectivity/lorawan/include/lorawan/LoRaWANStack.h b/connectivity/lorawan/include/lorawan/LoRaWANStack.h index dbdcac01d8..c5af18e215 100644 --- a/connectivity/lorawan/include/lorawan/LoRaWANStack.h +++ b/connectivity/lorawan/include/lorawan/LoRaWANStack.h @@ -28,7 +28,7 @@ * * \author Daniel Jaeckle ( STACKFORCE ) * - * \defgroup LoRaWAN stack layer that controls MAC layer underneath + * \addtogroup LoRaWAN * * License: Revised BSD License, see LICENSE.TXT file include in the project * diff --git a/connectivity/netsocket/include/netsocket/CellularInterface.h b/connectivity/netsocket/include/netsocket/CellularInterface.h index 817573d31c..fdb099b49e 100644 --- a/connectivity/netsocket/include/netsocket/CellularInterface.h +++ b/connectivity/netsocket/include/netsocket/CellularInterface.h @@ -20,7 +20,7 @@ #include "netsocket/NetworkInterface.h" /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ @@ -133,4 +133,8 @@ public: void set_default_parameters() override; }; +/** + * @} + */ + #endif // CELLULAR_INTERFACE_H_ diff --git a/connectivity/netsocket/include/netsocket/ControlPlane_netif.h b/connectivity/netsocket/include/netsocket/ControlPlane_netif.h index 994f2a9789..eb20cd5bbf 100644 --- a/connectivity/netsocket/include/netsocket/ControlPlane_netif.h +++ b/connectivity/netsocket/include/netsocket/ControlPlane_netif.h @@ -33,7 +33,7 @@ namespace mbed { /** - * @addtogroup cellular + * @addtogroup Cellular * @{ */ diff --git a/connectivity/netsocket/include/netsocket/DNS.h b/connectivity/netsocket/include/netsocket/DNS.h index fa17712b57..cd9ef06933 100644 --- a/connectivity/netsocket/include/netsocket/DNS.h +++ b/connectivity/netsocket/include/netsocket/DNS.h @@ -16,7 +16,9 @@ */ /** @file DNS.h Domain Name Service */ -/** @addtogroup netsocket +/** @defgroup NetSocket + * @ingroup connectivity-public-api + * @{ */ #ifndef DNS_H diff --git a/connectivity/netsocket/include/netsocket/DTLSSocket.h b/connectivity/netsocket/include/netsocket/DTLSSocket.h index d8a106f719..199a03e32b 100644 --- a/connectivity/netsocket/include/netsocket/DTLSSocket.h +++ b/connectivity/netsocket/include/netsocket/DTLSSocket.h @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * @{ */ diff --git a/connectivity/netsocket/include/netsocket/DTLSSocketWrapper.h b/connectivity/netsocket/include/netsocket/DTLSSocketWrapper.h index 17e2a6349a..171b249482 100644 --- a/connectivity/netsocket/include/netsocket/DTLSSocketWrapper.h +++ b/connectivity/netsocket/include/netsocket/DTLSSocketWrapper.h @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * @{ */ diff --git a/connectivity/netsocket/include/netsocket/EMACInterface.h b/connectivity/netsocket/include/netsocket/EMACInterface.h index 8cf47cb703..22acad4d8c 100644 --- a/connectivity/netsocket/include/netsocket/EMACInterface.h +++ b/connectivity/netsocket/include/netsocket/EMACInterface.h @@ -22,6 +22,9 @@ #include "EMAC.h" #include "OnboardNetworkStack.h" +/** \defgroup netinterface Network Interfaces + * \ingroup NetSocket */ +/** @{*/ /** EMACInterface class * Implementation of the NetworkInterface for an EMAC-based driver @@ -155,4 +158,6 @@ protected: mbed::Callback _connection_status_cb; }; +/** @}*/ + #endif diff --git a/connectivity/netsocket/include/netsocket/ICMPSocket.h b/connectivity/netsocket/include/netsocket/ICMPSocket.h index 1837bc8e09..409170ac44 100644 --- a/connectivity/netsocket/include/netsocket/ICMPSocket.h +++ b/connectivity/netsocket/include/netsocket/ICMPSocket.h @@ -1,4 +1,4 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* ICMPSocket * Copyright (c) 2015 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/InternetDatagramSocket.h b/connectivity/netsocket/include/netsocket/InternetDatagramSocket.h index ceac79f4db..19e6d4ab91 100644 --- a/connectivity/netsocket/include/netsocket/InternetDatagramSocket.h +++ b/connectivity/netsocket/include/netsocket/InternetDatagramSocket.h @@ -1,4 +1,4 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* InternetDatagramSocket * Copyright (c) 2015 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/InternetSocket.h b/connectivity/netsocket/include/netsocket/InternetSocket.h index 200b61a0cc..2281c18b99 100644 --- a/connectivity/netsocket/include/netsocket/InternetSocket.h +++ b/connectivity/netsocket/include/netsocket/InternetSocket.h @@ -1,5 +1,5 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* Socket * Copyright (c) 2015 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/L3IPInterface.h b/connectivity/netsocket/include/netsocket/L3IPInterface.h index 0f6968abb3..4ddf86fcdb 100644 --- a/connectivity/netsocket/include/netsocket/L3IPInterface.h +++ b/connectivity/netsocket/include/netsocket/L3IPInterface.h @@ -23,6 +23,9 @@ #include "OnboardNetworkStack.h" #include "SocketAddress.h" +/** \addtogroup netinterface */ +/** @{*/ + /** L3IPInterface class * Implementation of the NetworkInterface for an IP-based driver * @@ -162,4 +165,6 @@ protected: mbed::Callback _connection_status_cb; }; +/** @}*/ + #endif diff --git a/connectivity/netsocket/include/netsocket/NetworkStack.h b/connectivity/netsocket/include/netsocket/NetworkStack.h index 6d67566367..72fde98cf9 100644 --- a/connectivity/netsocket/include/netsocket/NetworkStack.h +++ b/connectivity/netsocket/include/netsocket/NetworkStack.h @@ -26,7 +26,7 @@ #include "DNS.h" /** @file NetworkStack.h NetworkStack class */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * @{ */ // Predeclared classes diff --git a/connectivity/netsocket/include/netsocket/Socket.h b/connectivity/netsocket/include/netsocket/Socket.h index 6ef5635ed2..021bae50ff 100644 --- a/connectivity/netsocket/include/netsocket/Socket.h +++ b/connectivity/netsocket/include/netsocket/Socket.h @@ -16,7 +16,7 @@ */ /** @file Socket.h Abstract Socket interface */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * Mbed OS Socket API * @{ */ diff --git a/connectivity/netsocket/include/netsocket/SocketAddress.h b/connectivity/netsocket/include/netsocket/SocketAddress.h index a2f11f7c39..aa3838cd73 100644 --- a/connectivity/netsocket/include/netsocket/SocketAddress.h +++ b/connectivity/netsocket/include/netsocket/SocketAddress.h @@ -16,7 +16,7 @@ */ /** @file SocketAddress.h SocketAddress class */ -/** \addtogroup netsocket +/** \addtogroup NetSocket * @{*/ #ifndef SOCKET_ADDRESS_H diff --git a/connectivity/netsocket/include/netsocket/TCPSocket.h b/connectivity/netsocket/include/netsocket/TCPSocket.h index 05f1d11da0..846225deb7 100644 --- a/connectivity/netsocket/include/netsocket/TCPSocket.h +++ b/connectivity/netsocket/include/netsocket/TCPSocket.h @@ -16,7 +16,7 @@ */ /** @file TCPSocket.h TCPSocket class */ -/** \addtogroup netsocket +/** \addtogroup NetSocket * @{*/ #ifndef TCPSOCKET_H diff --git a/connectivity/netsocket/include/netsocket/TLSSocket.h b/connectivity/netsocket/include/netsocket/TLSSocket.h index 14168012dc..af86e33de6 100644 --- a/connectivity/netsocket/include/netsocket/TLSSocket.h +++ b/connectivity/netsocket/include/netsocket/TLSSocket.h @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * @{ */ diff --git a/connectivity/netsocket/include/netsocket/TLSSocketWrapper.h b/connectivity/netsocket/include/netsocket/TLSSocketWrapper.h index 1ea28d8f61..cc1212a12b 100644 --- a/connectivity/netsocket/include/netsocket/TLSSocketWrapper.h +++ b/connectivity/netsocket/include/netsocket/TLSSocketWrapper.h @@ -15,7 +15,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -/** @addtogroup netsocket +/** @addtogroup NetSocket * @{ */ diff --git a/connectivity/netsocket/include/netsocket/UDPSocket.h b/connectivity/netsocket/include/netsocket/UDPSocket.h index 02b55ca029..b4db0f5267 100644 --- a/connectivity/netsocket/include/netsocket/UDPSocket.h +++ b/connectivity/netsocket/include/netsocket/UDPSocket.h @@ -1,5 +1,5 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* UDPSocket * Copyright (c) 2015 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/nsapi.h b/connectivity/netsocket/include/netsocket/nsapi.h index ed8899dcfa..017c15ce5e 100644 --- a/connectivity/netsocket/include/netsocket/nsapi.h +++ b/connectivity/netsocket/include/netsocket/nsapi.h @@ -1,5 +1,5 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* nsapi.h - The network socket API * Copyright (c) 2015 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/nsapi_dns.h b/connectivity/netsocket/include/netsocket/nsapi_dns.h index ef8811eb4e..7f32598619 100644 --- a/connectivity/netsocket/include/netsocket/nsapi_dns.h +++ b/connectivity/netsocket/include/netsocket/nsapi_dns.h @@ -16,7 +16,7 @@ * limitations under the License. */ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ #ifndef NSAPI_DNS_H diff --git a/connectivity/netsocket/include/netsocket/nsapi_ppp.h b/connectivity/netsocket/include/netsocket/nsapi_ppp.h index 6c6eed6c28..a2c607ed61 100644 --- a/connectivity/netsocket/include/netsocket/nsapi_ppp.h +++ b/connectivity/netsocket/include/netsocket/nsapi_ppp.h @@ -1,4 +1,4 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* nsapi_ppp.h * Modified work Copyright (c) 2017 ARM Limited diff --git a/connectivity/netsocket/include/netsocket/nsapi_types.h b/connectivity/netsocket/include/netsocket/nsapi_types.h index 3b496d5087..4ba62ed8c9 100644 --- a/connectivity/netsocket/include/netsocket/nsapi_types.h +++ b/connectivity/netsocket/include/netsocket/nsapi_types.h @@ -1,5 +1,5 @@ -/** \addtogroup netsocket */ +/** \addtogroup NetSocket */ /** @{*/ /* nsapi.h - The network socket API * Copyright (c) 2015 ARM Limited diff --git a/connectivity/nfc/include/nfc/NFCController.h b/connectivity/nfc/include/nfc/NFCController.h index cf09709fd0..d3a7160898 100644 --- a/connectivity/nfc/include/nfc/NFCController.h +++ b/connectivity/nfc/include/nfc/NFCController.h @@ -32,7 +32,8 @@ namespace mbed { namespace nfc { -/** @addtogroup nfc +/** @defgroup nfc NFC + * @ingroup connectivity-public-api * @{ */ diff --git a/connectivity/nfc/libraries/acore/acore/ac_buffer.h b/connectivity/nfc/libraries/acore/acore/ac_buffer.h index 68b84f65d3..3eada4a243 100644 --- a/connectivity/nfc/libraries/acore/acore/ac_buffer.h +++ b/connectivity/nfc/libraries/acore/acore/ac_buffer.h @@ -20,7 +20,8 @@ * \author Donatien Garnier */ -/** \addtogroup ACore +/** \defgroup ACore + * \ingroup nfc * @{ * \name Buffer * @{ diff --git a/connectivity/nfc/libraries/stack/ndef/ndef.h b/connectivity/nfc/libraries/stack/ndef/ndef.h index 6ff4eb93c1..7e4ba75765 100644 --- a/connectivity/nfc/libraries/stack/ndef/ndef.h +++ b/connectivity/nfc/libraries/stack/ndef/ndef.h @@ -21,6 +21,7 @@ */ /** \addtogroup NDEF + * \ingroup nfc * @{ * \name Generic NDEF Tag * @{ diff --git a/connectivity/nfc/libraries/stack/nfc_errors.h b/connectivity/nfc/libraries/stack/nfc_errors.h index f8870cbe1e..3ec0704bb8 100644 --- a/connectivity/nfc/libraries/stack/nfc_errors.h +++ b/connectivity/nfc/libraries/stack/nfc_errors.h @@ -21,7 +21,8 @@ * \details NFC Error codes */ -/** \addtogroup Core +/** \addtogroup nfc-errors Error Codes + * \ingroup nfc * @{ * \name Error codes * @{ diff --git a/connectivity/nfc/libraries/stack/platform/nfc_scheduler.h b/connectivity/nfc/libraries/stack/platform/nfc_scheduler.h index 6e1fb2dcf7..1b298634f5 100644 --- a/connectivity/nfc/libraries/stack/platform/nfc_scheduler.h +++ b/connectivity/nfc/libraries/stack/platform/nfc_scheduler.h @@ -19,7 +19,8 @@ * \copyright Copyright (c) ARM Ltd 2014 * \author Donatien Garnier */ -/** \addtogroup Core +/** \addtogroup nfc-scheduler Scheduler + * \ingroup nfc * @{ * \name Scheduler * @{ diff --git a/connectivity/nfc/libraries/stack/platform/nfc_transport.h b/connectivity/nfc/libraries/stack/platform/nfc_transport.h index 5e2528388c..df3a4d2e8b 100644 --- a/connectivity/nfc/libraries/stack/platform/nfc_transport.h +++ b/connectivity/nfc/libraries/stack/platform/nfc_transport.h @@ -20,7 +20,8 @@ * \author Donatien Garnier */ -/** \addtogroup Implementation +/** \addtogroup nfc-transport Transport + * \ingroup nfc * @{ * \name Transport * @{ diff --git a/connectivity/nfc/libraries/stack/transceiver/protocols.h b/connectivity/nfc/libraries/stack/transceiver/protocols.h index 6b62f6a10b..997a69757e 100644 --- a/connectivity/nfc/libraries/stack/transceiver/protocols.h +++ b/connectivity/nfc/libraries/stack/transceiver/protocols.h @@ -21,7 +21,8 @@ * \details List of RF protocols */ -/** \addtogroup Transceiver +/** \addtogroup nfc-protocols + * \ingroup nfc * @{ * \name Protocols and RF configuration * @{ diff --git a/doxyfile_options b/doxyfile_options index b52f40994d..4619a644fd 100644 --- a/doxyfile_options +++ b/doxyfile_options @@ -854,9 +854,11 @@ EXCLUDE_PATTERNS = */tools/* \ */cmsis/* \ */connectivity/drivers/emac/* \ */features/cryptocell/* \ + */features/frameworks/* \ */connectivity/mbedtls/* \ */features/unsupported/* \ */connectivity/lwipstack/* \ + */connectivity/lorawan/lorastack/* \ */connectivity/nanostack/sal-stack-nanostack/* \ */connectivity/nanostack/coap-service/* \ */mbed-trace/* \ @@ -865,12 +867,15 @@ EXCLUDE_PATTERNS = */tools/* \ */mbed-client-randlib/* \ */nanostack/sal-stack-nanostack-eventloop/* \ */connectivity/drivers/802.15.4_RF/* \ + */connectivity/drivers/wifi/COMPONENT_WHD/* \ + */connectivity/drivers/wifi/TARGET_STM/COMPONENT_EMW3080B/mx_wifi/* \ */components/wifi/* \ */UNITTESTS/* \ - */connectivity/cellular/framework/AT/* \ */connectivity/cellular/framework/device/* \ */connectivity/cellular/framework/common/* \ - */FEATURE_BLE/source/* + */FEATURE_BLE/source/* \ + */FEATURE_BLE/libraries/cordio_stack/* \ + */FEATURE_BLE/libraries/TARGET_*/stack/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/drivers/device_key/include/device_key/DeviceKey.h b/drivers/device_key/include/device_key/DeviceKey.h index 7c328e6c2a..1bcabfa432 100644 --- a/drivers/device_key/include/device_key/DeviceKey.h +++ b/drivers/device_key/include/device_key/DeviceKey.h @@ -33,8 +33,7 @@ #if (DEVICEKEY_ENABLED) || defined(DOXYGEN_ONLY) namespace mbed { -/** \addtogroup device-security Device Key - * \ingroup mbed-os-public +/** \addtogroup drivers-public-api * @{ */ @@ -64,9 +63,6 @@ enum DeviceKeyStatus { * @ingroup device-key */ /** - * \defgroup device-security_DeviceKey DeviceKey class - * \addtogroup device-security - * @{ */ class DeviceKey : private mbed::NonCopyable { public: @@ -155,7 +151,6 @@ private: }; -/** @}*/ /** @}*/ } diff --git a/hal/include/hal/analogin_api.h b/hal/include/hal/analogin_api.h index d172607c69..e0256fe8a2 100644 --- a/hal/include/hal/analogin_api.h +++ b/hal/include/hal/analogin_api.h @@ -1,5 +1,5 @@ -/** \addtogroup hal */ +/** \addtogroup hal HAL*/ /** @{*/ /* mbed Microcontroller Library * Copyright (c) 2006-2013 ARM Limited diff --git a/hal/tests/TESTS/mbed_hal/ospi/ospi_test.h b/hal/tests/TESTS/mbed_hal/ospi/ospi_test.h index 716e888413..1fac0b957f 100644 --- a/hal/tests/TESTS/mbed_hal/ospi/ospi_test.h +++ b/hal/tests/TESTS/mbed_hal/ospi/ospi_test.h @@ -15,12 +15,7 @@ * limitations under the License. */ -/** \addtogroup hal_ospi - * @{ - * \defgroup hal_ospi_tests Tests - * OSPI tests of the HAL. - * @{ - */ + #ifndef MBED_OSPI_TEST_H #define MBED_OSPI_TEST_H @@ -97,6 +92,3 @@ void ospi_write_read_test(void); #endif #endif - -/** @}*/ -/** @}*/ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto.h index b41a20bfc4..110f56be90 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto.h @@ -19,6 +19,17 @@ * limitations under the License. */ +/** \defgroup mbed-os-experimental Experimental APIs */ + +/** \defgroup experimental-crypto Cryptography + * \ingroup mbed-os-experimental + */ + +/** \defgroup experimental-crypto-psa Arm Platform Security Architecture (PSA) + * \ingroup experimental-crypto + * @{ + */ + #ifndef PSA_CRYPTO_H #define PSA_CRYPTO_H @@ -3749,3 +3760,5 @@ psa_status_t psa_generate_key(const psa_key_attributes_t *attributes, #include "crypto_extra.h" #endif /* PSA_CRYPTO_H */ + +/** @}*/ \ No newline at end of file diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_accel_driver.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_accel_driver.h index 4488ea8ad8..e762c13b03 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_accel_driver.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_accel_driver.h @@ -39,6 +39,7 @@ extern "C" { #endif /** \defgroup driver_digest Hardware-Accelerated Message Digests + * \ingroup experimental-crypto-psa * * Generation and authentication of Message Digests (aka hashes) must be done * in parts using the following sequence: @@ -146,6 +147,7 @@ typedef void (*psa_drv_hash_abort_t)(psa_drv_hash_context_t *p_context); /**@}*/ /** \defgroup accel_mac Hardware-Accelerated Message Authentication Code + * \ingroup experimental-crypto-psa * Generation and authentication of Message Authentication Codes (MACs) using * cryptographic accelerators can be done either as a single function call (via the * `psa_drv_accel_mac_generate_t` or `psa_drv_accel_mac_verify_t` @@ -348,6 +350,7 @@ typedef psa_status_t (*psa_drv_accel_mac_verify_t)(const uint8_t *p_input, /**@}*/ /** \defgroup accel_cipher Hardware-Accelerated Block Ciphers + * \ingroup experimental-crypto-psa * Encryption and Decryption using hardware-acceleration in block modes other * than ECB must be done in multiple parts, using the following flow: * - `psa_drv_accel_ciphersetup_t` @@ -506,6 +509,7 @@ typedef psa_status_t (*psa_drv_accel_cipher_abort_t)(psa_drv_accel_cipher_contex /**@}*/ /** \defgroup accel_aead Hardware-Accelerated Authenticated Encryption with Additional Data + * \ingroup experimental-crypto-psa * * Hardware-accelerated Authenticated Encryption with Additional Data (AEAD) * operations must be done in one function call. While this creates a burden @@ -624,6 +628,7 @@ typedef psa_status_t (*psa_drv_accel_aead_decrypt_t)(const uint8_t *p_key, /**@}*/ /** \defgroup accel_asymmetric Hardware-Accelerated Asymmetric Cryptography + * \ingroup experimental-crypto-psa * * Since the amount of data that can (or should) be encrypted or signed using * asymmetric keys is limited by the key size, hardware-accelerated asymmetric diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_entropy_driver.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_entropy_driver.h index 9b6546ee94..c73a06f258 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_entropy_driver.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_entropy_driver.h @@ -37,6 +37,7 @@ extern "C" { #endif /** \defgroup driver_rng Entropy Generation + * \ingroup experimental-crypto-psa */ /**@{*/ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_extra.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_extra.h index f793a6cacb..010c6ebcc4 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_extra.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_extra.h @@ -319,6 +319,7 @@ psa_status_t mbedtls_psa_inject_entropy(const uint8_t *seed, size_t seed_size); /** \addtogroup crypto_types + * \ingroup experimental-crypto-psa * @{ */ @@ -559,6 +560,7 @@ psa_status_t psa_get_key_domain_parameters( /**@}*/ /** \defgroup psa_tls_helpers TLS helper functions + * \ingroup experimental-crypto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_se_driver.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_se_driver.h index 1fae575161..498031bda8 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_se_driver.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_se_driver.h @@ -41,6 +41,7 @@ extern "C" { #endif /** \defgroup se_init Secure element driver initialization + \ingroup experimental-crypto-psa */ /**@{*/ @@ -151,6 +152,7 @@ typedef uint64_t psa_key_slot_number_t; /**@}*/ /** \defgroup se_mac Secure Element Message Authentication Codes + * \ingroup experimental-crypto-psa * Generation and authentication of Message Authentication Codes (MACs) using * a secure element can be done either as a single function call (via the * `psa_drv_se_mac_generate_t` or `psa_drv_se_mac_verify_t` functions), or in @@ -349,6 +351,7 @@ typedef struct { /**@}*/ /** \defgroup se_cipher Secure Element Symmetric Ciphers + * \ingroup experimental-crypto-psa * * Encryption and Decryption using secure element keys in block modes other * than ECB must be done in multiple parts, using the following flow: @@ -531,6 +534,7 @@ typedef struct { /**@}*/ /** \defgroup se_asymmetric Secure Element Asymmetric Cryptography + * \ingroup experimental-crypto-psa * * Since the amount of data that can (or should) be encrypted or signed using * asymmetric keys is limited by the key size, asymmetric key operations using @@ -693,6 +697,7 @@ typedef struct { /**@}*/ /** \defgroup se_aead Secure Element Authenticated Encryption with Additional Data + * \ingroup experimental-crypto-psa * Authenticated Encryption with Additional Data (AEAD) operations with secure * elements must be done in one function call. While this creates a burden for * implementers as there must be sufficient space in memory for the entire @@ -805,6 +810,7 @@ typedef struct { /**@}*/ /** \defgroup se_key_management Secure Element Key Management + * \ingroup experimental-crypto-psa * Currently, key management is limited to importing keys in the clear, * destroying keys, and exporting keys in the clear. * Whether a key may be exported is determined by the key policies in place @@ -1137,6 +1143,7 @@ typedef struct { /**@}*/ /** \defgroup driver_derivation Secure Element Key Derivation and Agreement + * \ingroup experimental-crypto-psa * Key derivation is the process of generating new key material using an * existing key and additional parameters, iterating through a basic * cryptographic function, such as a hash. @@ -1277,6 +1284,7 @@ typedef struct { /**@}*/ /** \defgroup se_registration Secure element driver registration + * \ingroup experimental-crypto-psa */ /**@{*/ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_values.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_values.h index f1b5c53ab2..e6a691806f 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_values.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/inc/psa/crypto_values.h @@ -35,6 +35,7 @@ #define PSA_CRYPTO_VALUES_H /** \defgroup error Error codes + * \ingroup experimental-crypto-psa * @{ */ @@ -273,6 +274,7 @@ /**@}*/ /** \defgroup crypto_types Key and algorithm types + * \ingroup experimental-crypto-psa * @{ */ @@ -1548,6 +1550,7 @@ /**@}*/ /** \defgroup key_lifetimes Key lifetimes + * \ingroup experimental-crypto-psa * @{ */ @@ -1751,6 +1754,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key ) /**@}*/ /** \defgroup policy Key policies + * \ingroup experimental-crypto-psa * @{ */ @@ -1832,6 +1836,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key ) /**@}*/ /** \defgroup derivation Key derivation + * \ingroup experimental-crypto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/services/attestation/psa_initial_attestation_api.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/services/attestation/psa_initial_attestation_api.h index 0b564998c6..b797c0a300 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/services/attestation/psa_initial_attestation_api.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_MBED_PSA_SRV/services/attestation/psa_initial_attestation_api.h @@ -12,7 +12,8 @@ /* to a stable set of APIs once all the feedback has been considered. */ /***************************************************************************/ -/** @addtogroup PSA-Attestation +/** @defgroup PSA-Attestation + @ingroup experimental-crypto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/mbedtls_ecc_group_to_psa.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/mbedtls_ecc_group_to_psa.h index 9a616a7626..4155b449f0 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/mbedtls_ecc_group_to_psa.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/mbedtls_ecc_group_to_psa.h @@ -34,6 +34,7 @@ extern "C" { #endif /** \defgroup psa_tls_helpers TLS helper functions + \ingroup experimental-cryto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_extra.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_extra.h index ebeefa26e9..e75c78f4df 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_extra.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_extra.h @@ -25,6 +25,7 @@ extern "C" { #endif /** \addtogroup crypto_types + * \ingroup experimental-crypto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_values.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_values.h index 78f9e8ec9e..d4bd56563b 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_values.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_LATEST/include/psa/crypto_values.h @@ -27,6 +27,7 @@ #include "mbedtls_svc_key_id.h" /** \defgroup error Error codes + * \ingroup experimental-crypto-psa * @{ */ @@ -307,6 +308,7 @@ /**@}*/ /** \defgroup crypto_types Key and algorithm types + * \ingroup experimental-crypto-psa * @{ */ @@ -1962,6 +1964,7 @@ /**@}*/ /** \defgroup key_lifetimes Key lifetimes + * \ingroup experimental-crypto-psa * @{ */ @@ -2096,6 +2099,7 @@ /**@}*/ /** \defgroup policy Key policies + * \ingroup experimental-crypto-psa * @{ */ @@ -2222,6 +2226,7 @@ /**@}*/ /** \defgroup derivation Key derivation + * \ingroup experimental-crypto-psa * @{ */ @@ -2298,6 +2303,7 @@ /**@}*/ /** \defgroup helper_macros Helper macros + * \ingroup experimental-crypto-psa * @{ */ diff --git a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_V1_0/include/psa/crypto_values.h b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_V1_0/include/psa/crypto_values.h index a7587fe605..e7b91dc3c4 100644 --- a/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_V1_0/include/psa/crypto_values.h +++ b/platform/FEATURE_EXPERIMENTAL_API/FEATURE_PSA/TARGET_TFM/TARGET_TFM_V1_0/include/psa/crypto_values.h @@ -27,6 +27,7 @@ #include "mbedtls_svc_key_id.h" /** \defgroup error Error codes + * \ingroup experimental-crypto-psa * @{ */ @@ -267,6 +268,7 @@ /**@}*/ /** \defgroup crypto_types Key and algorithm types + * \ingroup experimental-crypto-psa * @{ */ @@ -1554,6 +1556,7 @@ /**@}*/ /** \defgroup key_lifetimes Key lifetimes + * \ingroup experimental-crypto-psa * @{ */ @@ -1592,6 +1595,7 @@ /**@}*/ /** \defgroup policy Key policies + * \ingroup experimental-crypto-psa * @{ */ @@ -1673,6 +1677,7 @@ /**@}*/ /** \defgroup derivation Key derivation + * \ingroup experimental-crypto-psa * @{ */ diff --git a/storage/blockdevice/include/blockdevice/BlockDevice.h b/storage/blockdevice/include/blockdevice/BlockDevice.h index 688728e1a4..1de863be52 100644 --- a/storage/blockdevice/include/blockdevice/BlockDevice.h +++ b/storage/blockdevice/include/blockdevice/BlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_BLOCK_DEVICE_H #define MBED_BLOCK_DEVICE_H @@ -25,6 +23,13 @@ namespace mbed { +/** \defgroup storage Storage + * \ingroup mbed-os-public + * @{ + * \defgroup storage-blockdevice BlockDevice + * \ingroup storage */ +/** @{ */ + /** Enum of standard error codes * * @enum bd_error @@ -242,6 +247,10 @@ public: virtual const char *get_type() const = 0; }; +/** @} + * @} + */ + } // namespace mbed // Added "using" for backwards compatibility @@ -255,4 +264,3 @@ using mbed::BD_ERROR_DEVICE_ERROR; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/BufferedBlockDevice.h b/storage/blockdevice/include/blockdevice/BufferedBlockDevice.h index 94077dd6d0..6673af3346 100644 --- a/storage/blockdevice/include/blockdevice/BufferedBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/BufferedBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_BUFFERED_BLOCK_DEVICE_H #define MBED_BUFFERED_BLOCK_DEVICE_H @@ -25,6 +23,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Block device for allowing minimal read and program sizes (of 1) for the underlying BD, * using a buffer on the heap. */ @@ -180,6 +181,9 @@ protected: void invalidate_write_cache(); #endif //#if !(DOXYGEN_ONLY) }; + +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -188,5 +192,3 @@ using mbed::BufferedBlockDevice; #endif #endif - -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/ChainingBlockDevice.h b/storage/blockdevice/include/blockdevice/ChainingBlockDevice.h index 758d8738b5..32cc139e3d 100644 --- a/storage/blockdevice/include/blockdevice/ChainingBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/ChainingBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_CHAINING_BLOCK_DEVICE_H #define MBED_CHAINING_BLOCK_DEVICE_H @@ -27,6 +25,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Block device for chaining multiple block devices * with the similar block sizes at sequential addresses * @@ -185,6 +186,8 @@ protected: bool _is_initialized; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -193,5 +196,3 @@ using mbed::ChainingBlockDevice; #endif #endif - -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/ExhaustibleBlockDevice.h b/storage/blockdevice/include/blockdevice/ExhaustibleBlockDevice.h index aee08ce27a..7ac0997253 100644 --- a/storage/blockdevice/include/blockdevice/ExhaustibleBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/ExhaustibleBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_EXHAUSTIBLE_BLOCK_DEVICE_H #define MBED_EXHAUSTIBLE_BLOCK_DEVICE_H @@ -25,6 +23,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Heap backed block device which simulates failures * * Similar to heap block device but sectors wear out and are no longer programmable @@ -163,6 +164,8 @@ private: bool _is_initialized; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -171,5 +174,3 @@ using mbed::ExhaustibleBlockDevice; #endif #endif - -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/FlashSimBlockDevice.h b/storage/blockdevice/include/blockdevice/FlashSimBlockDevice.h index 6d5c72cf84..9e4a3287b6 100644 --- a/storage/blockdevice/include/blockdevice/FlashSimBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/FlashSimBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_FLASH_SIM_BLOCK_DEVICE_H #define MBED_FLASH_SIM_BLOCK_DEVICE_H @@ -25,6 +23,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + enum { BD_ERROR_NOT_ERASED = -3201, }; @@ -146,6 +147,8 @@ private: bool _is_initialized; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -155,4 +158,3 @@ using mbed::FlashSimBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/HeapBlockDevice.h b/storage/blockdevice/include/blockdevice/HeapBlockDevice.h index f853dc72cd..84b8abe19a 100644 --- a/storage/blockdevice/include/blockdevice/HeapBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/HeapBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_MEM_BLOCK_DEVICE_H #define MBED_MEM_BLOCK_DEVICE_H @@ -28,6 +26,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Lazily allocated heap-backed block device. * * Useful for simulating a block device and tests. @@ -163,6 +164,8 @@ private: bool _is_initialized; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -172,4 +175,3 @@ using mbed::HeapBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/MBRBlockDevice.h b/storage/blockdevice/include/blockdevice/MBRBlockDevice.h index 959c64d6f7..0847505143 100644 --- a/storage/blockdevice/include/blockdevice/MBRBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/MBRBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_MBR_BLOCK_DEVICE_H #define MBED_MBR_BLOCK_DEVICE_H @@ -25,6 +23,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Additional error codes used for MBR records */ enum { @@ -218,6 +219,8 @@ protected: bool _is_initialized; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -227,4 +230,3 @@ using mbed::MBRBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/ObservingBlockDevice.h b/storage/blockdevice/include/blockdevice/ObservingBlockDevice.h index 54b3918c30..94fa388c20 100644 --- a/storage/blockdevice/include/blockdevice/ObservingBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/ObservingBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_OBSERVING_BLOCK_DEVICE_H #define MBED_OBSERVING_BLOCK_DEVICE_H @@ -27,6 +25,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + class ObservingBlockDevice : public BlockDevice { public: @@ -146,6 +147,8 @@ private: mbed::Callback _change; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -154,5 +157,3 @@ using mbed::ObservingBlockDevice; #endif #endif - -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/ProfilingBlockDevice.h b/storage/blockdevice/include/blockdevice/ProfilingBlockDevice.h index 3f8f99f29b..5511e5184e 100644 --- a/storage/blockdevice/include/blockdevice/ProfilingBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/ProfilingBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_PROFILING_BLOCK_DEVICE_H #define MBED_PROFILING_BLOCK_DEVICE_H @@ -25,6 +23,8 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ /** Block device for measuring storage operations of another block device */ @@ -171,6 +171,8 @@ private: bd_size_t _erase_count; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -180,4 +182,3 @@ using mbed::ProfilingBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/ReadOnlyBlockDevice.h b/storage/blockdevice/include/blockdevice/ReadOnlyBlockDevice.h index 52df55ed4b..3c3e77d33e 100644 --- a/storage/blockdevice/include/blockdevice/ReadOnlyBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/ReadOnlyBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_READ_ONLY_BLOCK_DEVICE_H #define MBED_READ_ONLY_BLOCK_DEVICE_H @@ -26,6 +24,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice BlockDevice */ +/** @{*/ + class ReadOnlyBlockDevice : public BlockDevice { public: @@ -138,6 +139,8 @@ private: BlockDevice *_bd; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -147,4 +150,3 @@ using mbed::ReadOnlyBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/include/blockdevice/SlicingBlockDevice.h b/storage/blockdevice/include/blockdevice/SlicingBlockDevice.h index 73b3f1ec69..9cf6cf0734 100644 --- a/storage/blockdevice/include/blockdevice/SlicingBlockDevice.h +++ b/storage/blockdevice/include/blockdevice/SlicingBlockDevice.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_SLICING_BLOCK_DEVICE_H #define MBED_SLICING_BLOCK_DEVICE_H @@ -26,6 +24,9 @@ namespace mbed { +/** \addtogroup storage-blockdevice */ +/** @{*/ + /** Block device for mapping to a slice of another block device */ class SlicingBlockDevice : public BlockDevice { @@ -179,6 +180,8 @@ protected: bd_size_t _stop; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -188,4 +191,3 @@ using mbed::SlicingBlockDevice; #endif -/** @}*/ diff --git a/storage/blockdevice/source/ReadOnlyBlockDevice.cpp b/storage/blockdevice/source/ReadOnlyBlockDevice.cpp index 28237a3a86..ad1d1f513d 100644 --- a/storage/blockdevice/source/ReadOnlyBlockDevice.cpp +++ b/storage/blockdevice/source/ReadOnlyBlockDevice.cpp @@ -15,9 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ - #include "blockdevice/ReadOnlyBlockDevice.h" #include "platform/mbed_error.h" @@ -103,6 +100,4 @@ const char *ReadOnlyBlockDevice::get_type() const return NULL; } -} // namespace mbed - -/** @}*/ +} // namespace mbed \ No newline at end of file diff --git a/storage/filesystem/fat/include/fat/FATFileSystem.h b/storage/filesystem/fat/include/fat/FATFileSystem.h index 3c7577ff88..a3c86a3c1a 100644 --- a/storage/filesystem/fat/include/fat/FATFileSystem.h +++ b/storage/filesystem/fat/include/fat/FATFileSystem.h @@ -15,8 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ #ifndef MBED_FATFILESYSTEM_H #define MBED_FATFILESYSTEM_H @@ -30,6 +28,11 @@ namespace mbed { +/** \defgroup filesystem Filesystem + * \ingroup storage + * @{ + */ + /** * FAT file system based on ChaN's FAT file system library v0.8 * @@ -287,6 +290,9 @@ protected: virtual int mount(BlockDevice *bd, bool mount); }; +/** @} + */ + } // namespace mbed // Added "using" for backwards compatibility. @@ -296,4 +302,3 @@ using mbed::FATFileSystem; #endif -/** @}*/ diff --git a/storage/filesystem/include/filesystem/FileSystem.h b/storage/filesystem/include/filesystem/FileSystem.h index bf15244796..2000813e2d 100644 --- a/storage/filesystem/include/filesystem/FileSystem.h +++ b/storage/filesystem/include/filesystem/FileSystem.h @@ -27,7 +27,7 @@ #include "blockdevice/BlockDevice.h" namespace mbed { -/** \addtogroup file system */ +/** \addtogroup filesystem */ /** @{*/ diff --git a/storage/filesystem/include/filesystem/mbed_filesystem.h b/storage/filesystem/include/filesystem/mbed_filesystem.h index 454d05da73..04b3356df0 100644 --- a/storage/filesystem/include/filesystem/mbed_filesystem.h +++ b/storage/filesystem/include/filesystem/mbed_filesystem.h @@ -16,9 +16,6 @@ */ #ifndef MBED_FILESYSTEM_API_H #define MBED_FILESYSTEM_API_H -/** \addtogroup filesystem */ -/** @{*/ - // Standard types #include "platform/platform.h" @@ -34,5 +31,4 @@ #include "blockdevice/SlicingBlockDevice.h" #include "blockdevice/HeapBlockDevice.h" -/** @}*/ #endif diff --git a/storage/filesystem/littlefs/include/littlefs/LittleFileSystem.h b/storage/filesystem/littlefs/include/littlefs/LittleFileSystem.h index 432379a13f..93d0c65488 100644 --- a/storage/filesystem/littlefs/include/littlefs/LittleFileSystem.h +++ b/storage/filesystem/littlefs/include/littlefs/LittleFileSystem.h @@ -15,9 +15,6 @@ * limitations under the License. */ -/** \addtogroup storage */ -/** @{*/ - #ifndef MBED_LFSFILESYSTEM_H #define MBED_LFSFILESYSTEM_H @@ -27,6 +24,9 @@ #include "littlefs/lfs.h" namespace mbed { +/** \addtogroup filesystem + * @{ + */ /** * LittleFileSystem, a little file system @@ -301,6 +301,8 @@ private: rtos::Mutex _mutex; }; +/** @}*/ + } // namespace mbed // Added "using" for backwards compatibility @@ -310,4 +312,3 @@ using mbed::LittleFileSystem; #endif -/** @}*/