Clean up group/module definitions in doxygen (#97)

* Clean up group definitions in doxygen

* remove THIRD_PARTY_DOCS

* some stragglers

* fix astyle formatting
pull/15381/head
Jay Sridharan 2022-11-12 23:27:50 -08:00 committed by GitHub
parent e4469c3b24
commit 961632a860
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
134 changed files with 293 additions and 472 deletions

View File

@ -475,6 +475,11 @@ private:
bool event_signaled; bool event_signaled;
}; };
/**
* @}
*/
} }
using ble::BLE; using ble::BLE;
@ -482,8 +487,4 @@ using ble::BLE;
* @namespace ble Entry namespace for all BLE API definitions. * @namespace ble Entry namespace for all BLE API definitions.
*/ */
/**
* @}
*/
#endif /* ifndef MBED_BLE_H__ */ #endif /* ifndef MBED_BLE_H__ */

View File

@ -24,7 +24,8 @@ extern "C" {
#endif #endif
/** /**
* @addtogroup ble * @defgroup ble Bluetooth
* @ingroup connectivity-public-api
* @{ * @{
* @addtogroup common * @addtogroup common
* @{ * @{

View File

@ -397,7 +397,7 @@ uint32_t BbGetTargetTimeDelta(uint32_t targetUsec, uint32_t refUsec);
/*************************************************************************************************/ /*************************************************************************************************/
uint8_t BbGetActiveProtocol(void); uint8_t BbGetActiveProtocol(void);
/*! \} */ /* BB_API_CTRL */ /*! \} */ /* BB_API_CTRL */
#ifdef __cplusplus #ifdef __cplusplus
}; };

View File

@ -1,4 +1,4 @@
/** /*
* Copyright (c) 2014 - 2019, Nordic Semiconductor ASA * Copyright (c) 2014 - 2019, Nordic Semiconductor ASA
* *
* All rights reserved. * All rights reserved.
@ -37,6 +37,7 @@
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* *
*/ */
#ifndef BOARDS_H #ifndef BOARDS_H
#define BOARDS_H #define BOARDS_H
@ -92,7 +93,8 @@
extern "C" { extern "C" {
#endif #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_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).*/ #define BSP_INIT_LEDS (1 << 0) /**< Enable LEDs during initialization (@ref bsp_board_init).*/

View File

@ -29,7 +29,7 @@
namespace mbed { namespace mbed {
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/** Socket implementation for cellular Non-IP data delivery(NIDD). /** Socket implementation for cellular Non-IP data delivery(NIDD).

View File

@ -32,7 +32,12 @@
namespace mbed { namespace mbed {
/** /**
* @addtogroup cellular * @defgroup connectivity-public-api Connectivity
* @ingroup mbed-os-public
* @{
* @defgroup Cellular
* @ingroup connectivity-public-api
* @{ * @{
*/ */
@ -396,6 +401,7 @@ protected:
}; };
/** /**
* @}
* @} * @}
*/ */

View File

@ -43,7 +43,7 @@ const int MAX_PLMN_SIZE = 16;
const int MAX_SIM_READY_WAITING_TIME = 30; const int MAX_SIM_READY_WAITING_TIME = 30;
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */

View File

@ -27,7 +27,7 @@ const int MAX_ICCID_LENGTH = 20 + 1; // +1 for zero termination
namespace mbed { namespace mbed {
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */

View File

@ -31,7 +31,7 @@ const int MAX_OPERATOR_NAME_LONG = 16;
const int MAX_OPERATOR_NAME_SHORT = 8; const int MAX_OPERATOR_NAME_SHORT = 8;
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */

View File

@ -38,7 +38,7 @@ const uint16_t SMS_SIM_WAIT_TIME_MILLISECONDS = 200;
const int SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ = -5001; const int SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ = -5001;
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */

View File

@ -22,10 +22,17 @@
#include "rtos/Semaphore.h" #include "rtos/Semaphore.h"
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
const int MAX_APN_LENGTH = 63 + 1; const int MAX_APN_LENGTH = 63 + 1;
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
class AT_CellularContext : public CellularContext { class AT_CellularContext : public CellularContext {
public: public:
AT_CellularContext(ATHandler &at, CellularDevice *device, const char *apn = 0, bool cp_req = false, bool nonip_req = false); 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; ATHandler &_at;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif // AT_CELLULARCONTEXT_H_ #endif // AT_CELLULARCONTEXT_H_

View File

@ -23,6 +23,12 @@
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
class AT_CellularInformation; class AT_CellularInformation;
class AT_CellularNetwork; class AT_CellularNetwork;
class AT_CellularSMS; class AT_CellularSMS;
@ -202,5 +208,9 @@ private:
const intptr_t *_property_array; const intptr_t *_property_array;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif // AT_CELLULAR_DEVICE_H_ #endif // AT_CELLULAR_DEVICE_H_

View File

@ -22,8 +22,15 @@
#include "ATHandler.h" #include "ATHandler.h"
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
/** /**
* Class AT_CellularInformation * Class AT_CellularInformation
* *
@ -63,6 +70,10 @@ protected:
AT_CellularDevice &_device; AT_CellularDevice &_device;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif // AT_CELLULAR_INFORMATION_H_ #endif // AT_CELLULAR_INFORMATION_H_

View File

@ -22,8 +22,15 @@
#include "ATHandler.h" #include "ATHandler.h"
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
#define AT_NETWORK_TRIALS 5 #define AT_NETWORK_TRIALS 5
#define TIMER_UNIT_LENGTH 3 #define TIMER_UNIT_LENGTH 3
#define TWO_BYTES_HEX 4 #define TWO_BYTES_HEX 4
@ -148,6 +155,10 @@ protected:
AT_CellularDevice &_device; AT_CellularDevice &_device;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif // AT_CELLULAR_NETWORK_H_ #endif // AT_CELLULAR_NETWORK_H_

View File

@ -26,8 +26,15 @@
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
#include <time.h> #include <time.h>
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
/** /**
* Class AT_CellularSMS * Class AT_CellularSMS
* *
@ -171,6 +178,10 @@ private:
AT_CellularDevice &_device; AT_CellularDevice &_device;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif //MBED_CONF_CELLULAR_USE_SMS #endif //MBED_CONF_CELLULAR_USE_SMS

View File

@ -23,8 +23,15 @@
#include "rtos/Mutex.h" #include "rtos/Mutex.h"
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
// <PDP_addr_1> and <PDP_addr_2>: each is a string type that identifies the MT in the address space applicable to the PDP. // <PDP_addr_1> and <PDP_addr_2>: 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: // The string is given as dot-separated numeric (0-255) parameter of the form:
// a1.a2.a3.a4 for IPv4 and // a1.a2.a3.a4 for IPv4 and
@ -215,6 +222,10 @@ protected:
AT_CellularDevice &_device; AT_CellularDevice &_device;
}; };
/**
* @}
*/
} // namespace mbed } // namespace mbed
#endif // AT_CELLULAR_STACK_H_ #endif // AT_CELLULAR_STACK_H_

View File

@ -20,8 +20,15 @@
#include "ATHandler.h" #include "ATHandler.h"
#include "AT_CellularDevice.h" #include "AT_CellularDevice.h"
namespace mbed { namespace mbed {
/**
* @addtogroup at-hayes AT/Hayes Command Set
* @ingroup Cellular
* @{
*/
class AT_ControlPlane_netif: public ControlPlane_netif { class AT_ControlPlane_netif: public ControlPlane_netif {
public: public:
AT_ControlPlane_netif(ATHandler &at, int cid, AT_CellularDevice &device); AT_ControlPlane_netif(ATHandler &at, int cid, AT_CellularDevice &device);
@ -63,4 +70,8 @@ protected:
AT_CellularDevice &_device; AT_CellularDevice &_device;
}; };
/**
* @}
*/
} //mbed namespace } //mbed namespace

View File

@ -52,10 +52,6 @@ extern "C"
@file @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. @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. 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 @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. 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
/**
@}
*/
#endif /*#ifndef CRYS_AESCCM_H*/ #endif /*#ifndef CRYS_AESCCM_H*/

View File

@ -49,9 +49,7 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS AESCCM errors. @brief This module contains the definitions of the CRYS AESCCM errors.
@defgroup crys_aesccm_error CryptoCell AES-CCM specific errors
@{
@ingroup crys_aesccm
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -125,10 +123,4 @@ extern "C"
} }
#endif #endif
/** #endif
@}
*/
#endif

View File

@ -37,9 +37,7 @@
@file @file
@brief This file contains all of the enums and definitions that are used for the @brief This file contains all of the enums and definitions that are used for the
CRYS CHACHA APIs, as well as the APIs themselves. CRYS CHACHA APIs, as well as the APIs themselves.
@defgroup crys_chacha CryptoCell CHACHA APIs
@{
@ingroup cryptocell_api
*/ */
#ifndef CRYS_CHACHA_H #ifndef CRYS_CHACHA_H
#define CRYS_CHACHA_H #define CRYS_CHACHA_H
@ -222,10 +220,6 @@ CIMPORT_C CRYSError_t CRYS_CHACHA(
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef CRYS_CHACHA_H */ #endif /* #ifndef CRYS_CHACHA_H */

View File

@ -47,9 +47,7 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS CHACHA errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions that are used for the @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. 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 #ifndef CRYS_CHACHA_POLY_H
#define CRYS_CHACHA_POLY_H #define CRYS_CHACHA_POLY_H
@ -84,12 +81,4 @@ CIMPORT_C CRYSError_t CRYS_CHACHA_POLY(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/** #endif /* #ifndef CRYS_CHACHA_POLY_H */
@}
*/
#endif /* #ifndef CRYS_CHACHA_POLY_H */

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS CHACHA POLY errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -51,9 +51,6 @@ extern "C"
/*! /*!
@file @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). @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -49,9 +49,6 @@ extern "C"
/*! /*!
@file @file
@brief This file contains error codes definitions for CRYS DH module. @brief This file contains error codes definitions for CRYS DH module.
@defgroup crys_dh_error CryptoCell DH specific errors
@{
@ingroup crys_dh
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
/* DH module on the CRYS layer base address - 0x00F00500 */ /* DH module on the CRYS layer base address - 0x00F00500 */
@ -151,8 +148,5 @@ extern "C"
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -49,9 +49,6 @@ extern "C"
/*! @file /*! @file
@brief This module defines the API that supports Diffie-Hellman domain. @brief This module defines the API that supports Diffie-Hellman domain.
@defgroup crys_dh_kg CryptoCell DH Key Generation APIs
@{
@ingroup crys_dh
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -197,7 +194,4 @@ CIMPORT_C CRYSError_t CRYS_DH_CheckDomainParams(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,17 +47,11 @@ extern "C" {
#endif #endif
/*! /*!
@defgroup cryptocell_ec CryptoCell EC 25519 curve APIs
@{
@ingroup cryptocell_api
@brief This group is the cryptocell EC 25519 curve root group @brief This group is the cryptocell EC 25519 curve root group
@} @}
@file @file
@brief This file contains the CRYS APIs used for EC EDW (Edwards) ed25519 algorithms. @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 \note Algorithms of Montgomery and Edwards elliptic curves cryptography were developed by
Daniel.J.Bernstein. Daniel.J.Bernstein.
@ -192,9 +186,6 @@ CIMPORT_C CRYSError_t CRYS_ECEDW_KeyPair (
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -48,9 +48,6 @@ extern "C" {
/*! /*!
@file @file
@brief This file contains the CRYS APIs used for EC MONT (Montgomery Curve25519) algorithms. @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, \note Implemented algorithms according to Montgomery elliptic curves cryptography,
@ -204,9 +201,6 @@ CIMPORT_C CRYSError_t CRYS_ECMONT_SeedKeyPair (
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -39,9 +39,6 @@
/*! /*!
@file @file
@brief This module containes the definitions of the CRYS ECC-25519 errors. @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" #include "crys_error.h"

View File

@ -37,17 +37,11 @@
#define CRYS_ECPKI_BUILD_H #define CRYS_ECPKI_BUILD_H
/*! /*!
@defgroup cryptocell_ecpki CryptoCell ECC APIs
@{
@ingroup cryptocell_api
@brief This group is the cryptocell ECC root group @brief This group is the cryptocell ECC root group
@} @}
@file @file
@brief This module defines functions for building key structures used in Elliptic Curves Cryptography (ECC). @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -39,9 +39,6 @@
/*! @file /*! @file
@brief Defines the API that supports EC Diffie-Hellman shared secret value derivation primitives. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -41,9 +41,6 @@
/*! /*!
@file @file
@brief Defines the ecpki build domain API. @brief Defines the ecpki build domain API.
@defgroup crys_ecpki_domain CryptoCell ECC domain APIs
@{
@ingroup cryptocell_ecpki
*/ */

View File

@ -40,9 +40,6 @@
/*! /*!
@file @file
@brief Defines the APIs that support the ECDSA functions. @brief Defines the APIs that support the ECDSA functions.
@defgroup crys_ecpki_ecdsa CryptoCell ECDSA APIs
@{
@ingroup cryptocell_ecpki
*/ */
#include "crys_error.h" #include "crys_error.h"
@ -133,7 +130,4 @@ CIMPORT_C CRYSError_t CRYS_ECDSA_Verify (
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -41,9 +41,6 @@
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS ECPKI errors. @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" #include "crys_error.h"
@ -295,9 +292,6 @@ extern "C"
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -39,9 +39,6 @@
/*! @file /*! @file
@brief Defines the API for generation of ECC private and public keys. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -40,9 +40,6 @@
/*! /*!
@file @file
@brief Contains all of the enums and definitions that are used for the CRYS ECPKI APIs. @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" #include "ssi_pal_types_plat.h"
@ -472,7 +469,4 @@ typedef struct CRYS_ECDHFipsKatContext_t{
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -46,9 +46,6 @@ extern "C"
/*! @file /*! @file
@brief This module defines the error return code types and the numbering spaces of the error codes @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. 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 */ /*! The definitions of the error number space used for the different modules */
@ -263,9 +260,6 @@ typedef uint32_t CRYSError_t;
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions @brief This file contains all of the enums and definitions
that are used for the CRYS HASH APIs, as well as the APIs themselves. 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): This product supports the following HASH algorithms (or modes, according to product):
@ -279,7 +276,4 @@ CIMPORT_C CRYSError_t CRYS_HASH (
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -39,9 +39,6 @@
/*! /*!
@file @file
@brief This file contains HASH definitions. @brief This file contains HASH definitions.
@defgroup crys_hash_defs CryptoCell Hash definitions
@{
@ingroup crys_hash
*/ */
#ifdef __cplusplus #ifdef __cplusplus

View File

@ -49,9 +49,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS HASH errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -46,9 +46,6 @@ extern "C"
/*! /*!
@file @file
@brief This module defines the API that supports HMAC Key derivation function as defined by RFC5869. @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. */ /*! HKDF maximal key size in words. */
@ -117,8 +114,5 @@ CEXPORT_C CRYSError_t CRYS_HKDF_KeyDerivFunc(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS HKDF errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions @brief This file contains all of the enums and definitions
that are used for the CRYS HMAC APIs, as well as the APIs themselves. 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, 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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -45,9 +45,6 @@ extern "C"
/*! /*!
@file @file
@brief This file contains HMAC definitions. @brief This file contains HMAC definitions.
@defgroup crys_hmac_defs CryptoCell Hmac definitions
@{
@ingroup crys_hmac
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -58,7 +55,4 @@ extern "C"
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -46,9 +46,6 @@ extern "C"
/*! @file /*! @file
@brief This module contains the definitions of the CRYS HMAC errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -48,9 +48,6 @@ extern "C"
@file @file
@brief This module defines the API that supports Key derivation function in modes @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. 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" #include "crys_hash.h"
@ -204,8 +201,5 @@ CIMPORT_C CRYSError_t CRYS_KDF_KeyDerivFunc(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS KDF errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -42,17 +42,11 @@
#include "ssi_pka_hw_plat_defs.h" #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 @brief This group is the cryptocell PKA root group
@} @}
@file @file
@brief The file contains all of the enums and definitions that are used in the PKA related code. @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
*/ */

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions that are used for the @brief This file contains all of the enums and definitions that are used for the
CRYS POLY APIs, as well as the APIs themselves. CRYS POLY APIs, as well as the APIs themselves.
@defgroup crys_poly CryptoCell POLY APIs
@{
@ingroup cryptocell_api
*/ */
#ifndef CRYS_POLY_H #ifndef CRYS_POLY_H
@ -96,9 +93,6 @@ CIMPORT_C CRYSError_t CRYS_POLY(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef CRYS_POLY_H */ #endif /* #ifndef CRYS_POLY_H */

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS POLY errors. @brief This module contains the definitions of the CRYS POLY errors.
@defgroup crys_poly_error CryptoCell POLY specific errors
@{
@ingroup crys_poly
*/ */

View File

@ -50,9 +50,6 @@ extern "C"
@file @file
@brief This file contains the CRYS APIs used for random number generation. @brief This file contains the CRYS APIs used for random number generation.
The random-number generation module implements referenced standard [SP800-90]. The random-number generation module implements referenced standard [SP800-90].
@defgroup crys_rnd CryptoCell Random Generator APIs
@{
@ingroup cryptocell_api
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -373,8 +370,5 @@ CIMPORT_C void CRYS_RND_DisableKatMode(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef CRYS_RND_H */ #endif /* #ifndef CRYS_RND_H */

View File

@ -49,9 +49,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS RND errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,17 +47,11 @@ extern "C"
#endif #endif
/*! /*!
@defgroup crys_rsa CryptoCell RSA APIs
@{
@ingroup cryptocell_api
@brief This group is the cryptocell ECC root group @brief This group is the cryptocell ECC root group
@} @}
@file @file
@brief This module defines some utility functions for working with RSA cryptography. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,9 +47,6 @@ extern "C"
/*! @file /*! @file
@brief This module contains the definitions of the CRYS RSA errors. @brief This module contains the definitions of the CRYS RSA errors.
@defgroup crys_rsa_error CryptoCell RSA specific errors
@{
@ingroup crys_rsa
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -269,9 +266,6 @@ extern "C"
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -49,9 +49,6 @@ extern "C"
/*! /*!
@file @file
@brief Generates a RSA pair of public and private keys. @brief Generates a RSA pair of public and private keys.
@defgroup crys_rsa_kg CryptoCell RSA key generation APIs
@{
@ingroup crys_rsa
*/ */
/************************ Defines ******************************/ /************************ Defines ******************************/
@ -121,9 +118,6 @@ CIMPORT_C CRYSError_t CRYS_RSA_KG_GenerateKeyPairCRT(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module defines the API that implements the [PKCS1_2.1] primitive functions. @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 \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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -50,9 +50,6 @@ extern "C"
/*! /*!
@file @file
@brief This module defines APIs that support [PKCS1_1.5] and [PKCS1_2.1] encryption and signature schemes. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -53,9 +53,6 @@ extern "C"
/*! /*!
@file @file
@brief This file contains all of the enums and definitions that are used for the CRYS RSA APIs. @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 ******************************/ /************************ Defines ******************************/
@ -610,7 +607,4 @@ typedef struct CRYS_RSAFipsKatContext_t{
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions that are used for the @brief This file contains all of the enums and definitions that are used for the
CRYS SRP APIs, as well as the APIs themselves. CRYS SRP APIs, as well as the APIs themselves.
@defgroup crys_srp CryptoCell SRP APIs
@{
@ingroup cryptocell_api
*/ */
#ifndef CRYS_SRP_H #ifndef CRYS_SRP_H
@ -364,9 +361,6 @@ CIMPORT_C CRYSError_t CRYS_SRP_UserProofVerify(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef CRYS_SRP_H */ #endif /* #ifndef CRYS_SRP_H */

View File

@ -47,9 +47,6 @@ extern "C"
/*! /*!
@file @file
@brief This module contains the definitions of the CRYS SRP errors. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -37,9 +37,6 @@
@file @file
@brief This file contains all of the enums and definitions that are used for the @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. 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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /*__DX_CCLIB_H__*/ #endif /*__DX_CCLIB_H__*/

View File

@ -36,9 +36,6 @@
/*! @file /*! @file
@brief This file contains all of the enums and definitions that are used for the @brief This file contains all of the enums and definitions that are used for the
CryptoCell AES APIs, as well as the APIs themselves. CryptoCell AES APIs, as well as the APIs themselves.
@defgroup ssi_aes CryptoCell AES APIs
@{
@ingroup cryptocell_api
*/ */
#ifndef SSI_AES_H #ifndef SSI_AES_H
@ -318,8 +315,5 @@ CIMPORT_C SaSiError_t SaSi_AesFree(
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef SSI_AES_H */ #endif /* #ifndef SSI_AES_H */

View File

@ -36,9 +36,6 @@
/*! /*!
@file @file
@brief This file contains definitions that are used for the ARM CryptoCell 3xx version of the CryptoCell AES APIs. @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef SSI_AES_DEFS_H */ #endif /* #ifndef SSI_AES_DEFS_H */

View File

@ -36,9 +36,6 @@
/*! /*!
@file @file
@brief This file contains the definitions of the CryptoCell AES errors. @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 #ifndef SSI_AES_ERROR_H
@ -127,7 +124,4 @@ extern "C"
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif /* #ifndef SSI_AES_ERROR_H */ #endif /* #ifndef SSI_AES_ERROR_H */

View File

@ -39,9 +39,6 @@
/*! /*!
@file @file
@brief This file contains compiler related definitions. @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 #else
#error Unsupported compiler. #error Unsupported compiler.
#endif #endif
/**
@}
*/
#endif /*__SSI_PAL_COMPILER_H__*/ #endif /*__SSI_PAL_COMPILER_H__*/

View File

@ -58,9 +58,6 @@ SaSiError_t SaSi_PalTrngParameterGet(uint32_t *SubSamplingRatio /*!< [out] TRNG
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif #endif

View File

@ -36,9 +36,6 @@
/*! /*!
@file @file
@brief This file contains the platform dependent definitions and types. @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 #ifndef SSI_PAL_TYPES_H

View File

@ -45,9 +45,6 @@ extern "C"
/*! /*!
@file @file
@brief Contains the enums and definitions that are used in the PKA code (definitions that are platform dependent). @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 #ifdef __cplusplus
} }
#endif #endif
/**
@}
*/
#endif //PKA_HW_PLAT_DEFS_H #endif //PKA_HW_PLAT_DEFS_H

View File

@ -19,16 +19,6 @@
#ifndef MBEDTLS_AES_ALT_H #ifndef MBEDTLS_AES_ALT_H
#define 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) #if defined(MBEDTLS_AES_ALT)
/* SiliconLabs CRYPTO hardware acceleration implementation */ /* SiliconLabs CRYPTO hardware acceleration implementation */
@ -312,7 +302,5 @@ MBEDTLS_DEPRECATED static inline void mbedtls_aes_decrypt(
#endif /* MBEDTLS_AES_ALT */ #endif /* MBEDTLS_AES_ALT */
/** \} (end addtogroup sl_crypto_aes) */
/** \} (end addtogroup sl_crypto) */
#endif /* MBEDTLS_AES_ALT_H */ #endif /* MBEDTLS_AES_ALT_H */

View File

@ -21,12 +21,6 @@
#define CRYPTO_MANAGEMENT_H #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 * \brief Management functions for CRYPTO peripherals. These functions take care
* of not having two 'owners' simultaneously for the same peripheral, * of not having two 'owners' simultaneously for the same peripheral,
* potentially messing up the internal state of said 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 */ #endif /* CRYPTO_PRESENT */
/** \} (end addtogroup sl_crypto_management) */ /** \}*/
/** \} (end addtogroup sl_crypto) */
#endif /* CRYPTO_MANAGEMENT_H */ #endif /* CRYPTO_MANAGEMENT_H */

View File

@ -21,17 +21,6 @@
#ifndef MBEDTLS_SHA1_ALT_H #ifndef MBEDTLS_SHA1_ALT_H
#define 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) #if defined(MBEDTLS_SHA1_ALT)
#include <stdint.h> #include <stdint.h>
@ -186,7 +175,4 @@ MBEDTLS_DEPRECATED void mbedtls_sha1_process( mbedtls_sha1_context *ctx,
#endif /* #if defined(MBEDTLS_SHA1_ALT) */ #endif /* #if defined(MBEDTLS_SHA1_ALT) */
/** \} (end addtogroup sl_crypto_sha1) */
/** \} (end addtogroup sl_crypto) */
#endif /* #ifndef MBEDTLS_SHA1_ALT_H */ #endif /* #ifndef MBEDTLS_SHA1_ALT_H */

View File

@ -22,12 +22,6 @@
#define MBEDTLS_SHA256_ALT_H #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. * \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) */ #endif /* #if defined(MBEDTLS_SHA256_ALT) */
/** \} (end addtogroup sl_crypto_sha256) */ /** \} */
/** \} (end addtogroup sl_crypto) */
#endif /* #ifndef MBEDTLS_SHA256_ALT_H */ #endif /* #ifndef MBEDTLS_SHA256_ALT_H */

View File

@ -1497,12 +1497,6 @@ int32_t MX_WIFI_FOTA_start(MX_WIFIObject_t *Obj, const char *url, const char *md
*/ */
/**
* @} **
*/
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif /* __cplusplus */ #endif /* __cplusplus */

View File

@ -19,6 +19,7 @@
#define LORARADIO_H_ #define LORARADIO_H_
/** @addtogroup LoRaWAN /** @addtogroup LoRaWAN
* @ingroup connectivity-public-api
* Parent class for a LoRa radio driver * Parent class for a LoRa radio driver
* @{ * @{
*/ */

View File

@ -28,7 +28,7 @@
* *
* \author Daniel Jaeckle ( STACKFORCE ) * \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 * License: Revised BSD License, see LICENSE.TXT file include in the project
* *

View File

@ -20,7 +20,7 @@
#include "netsocket/NetworkInterface.h" #include "netsocket/NetworkInterface.h"
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */
@ -133,4 +133,8 @@ public:
void set_default_parameters() override; void set_default_parameters() override;
}; };
/**
* @}
*/
#endif // CELLULAR_INTERFACE_H_ #endif // CELLULAR_INTERFACE_H_

View File

@ -33,7 +33,7 @@ namespace mbed {
/** /**
* @addtogroup cellular * @addtogroup Cellular
* @{ * @{
*/ */

View File

@ -16,7 +16,9 @@
*/ */
/** @file DNS.h Domain Name Service */ /** @file DNS.h Domain Name Service */
/** @addtogroup netsocket /** @defgroup NetSocket
* @ingroup connectivity-public-api
* @{ */ * @{ */
#ifndef DNS_H #ifndef DNS_H

View File

@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket /** @addtogroup NetSocket
* @{ * @{
*/ */

View File

@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket /** @addtogroup NetSocket
* @{ * @{
*/ */

View File

@ -22,6 +22,9 @@
#include "EMAC.h" #include "EMAC.h"
#include "OnboardNetworkStack.h" #include "OnboardNetworkStack.h"
/** \defgroup netinterface Network Interfaces
* \ingroup NetSocket */
/** @{*/
/** EMACInterface class /** EMACInterface class
* Implementation of the NetworkInterface for an EMAC-based driver * Implementation of the NetworkInterface for an EMAC-based driver
@ -155,4 +158,6 @@ protected:
mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb; mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
}; };
/** @}*/
#endif #endif

View File

@ -1,4 +1,4 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* ICMPSocket /* ICMPSocket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -1,4 +1,4 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* InternetDatagramSocket /* InternetDatagramSocket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -1,5 +1,5 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* Socket /* Socket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -23,6 +23,9 @@
#include "OnboardNetworkStack.h" #include "OnboardNetworkStack.h"
#include "SocketAddress.h" #include "SocketAddress.h"
/** \addtogroup netinterface */
/** @{*/
/** L3IPInterface class /** L3IPInterface class
* Implementation of the NetworkInterface for an IP-based driver * Implementation of the NetworkInterface for an IP-based driver
* *
@ -162,4 +165,6 @@ protected:
mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb; mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
}; };
/** @}*/
#endif #endif

View File

@ -26,7 +26,7 @@
#include "DNS.h" #include "DNS.h"
/** @file NetworkStack.h NetworkStack class */ /** @file NetworkStack.h NetworkStack class */
/** @addtogroup netsocket /** @addtogroup NetSocket
* @{ */ * @{ */
// Predeclared classes // Predeclared classes

View File

@ -16,7 +16,7 @@
*/ */
/** @file Socket.h Abstract Socket interface */ /** @file Socket.h Abstract Socket interface */
/** @addtogroup netsocket /** @addtogroup NetSocket
* Mbed OS Socket API * Mbed OS Socket API
* @{ */ * @{ */

View File

@ -16,7 +16,7 @@
*/ */
/** @file SocketAddress.h SocketAddress class */ /** @file SocketAddress.h SocketAddress class */
/** \addtogroup netsocket /** \addtogroup NetSocket
* @{*/ * @{*/
#ifndef SOCKET_ADDRESS_H #ifndef SOCKET_ADDRESS_H

View File

@ -16,7 +16,7 @@
*/ */
/** @file TCPSocket.h TCPSocket class */ /** @file TCPSocket.h TCPSocket class */
/** \addtogroup netsocket /** \addtogroup NetSocket
* @{*/ * @{*/
#ifndef TCPSOCKET_H #ifndef TCPSOCKET_H

View File

@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket /** @addtogroup NetSocket
* @{ * @{
*/ */

View File

@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
/** @addtogroup netsocket /** @addtogroup NetSocket
* @{ * @{
*/ */

View File

@ -1,5 +1,5 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* UDPSocket /* UDPSocket
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -1,5 +1,5 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* nsapi.h - The network socket API /* nsapi.h - The network socket API
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -16,7 +16,7 @@
* limitations under the License. * limitations under the License.
*/ */
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
#ifndef NSAPI_DNS_H #ifndef NSAPI_DNS_H

View File

@ -1,4 +1,4 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* nsapi_ppp.h /* nsapi_ppp.h
* Modified work Copyright (c) 2017 ARM Limited * Modified work Copyright (c) 2017 ARM Limited

View File

@ -1,5 +1,5 @@
/** \addtogroup netsocket */ /** \addtogroup NetSocket */
/** @{*/ /** @{*/
/* nsapi.h - The network socket API /* nsapi.h - The network socket API
* Copyright (c) 2015 ARM Limited * Copyright (c) 2015 ARM Limited

View File

@ -32,7 +32,8 @@
namespace mbed { namespace mbed {
namespace nfc { namespace nfc {
/** @addtogroup nfc /** @defgroup nfc NFC
* @ingroup connectivity-public-api
* @{ * @{
*/ */

View File

@ -20,7 +20,8 @@
* \author Donatien Garnier * \author Donatien Garnier
*/ */
/** \addtogroup ACore /** \defgroup ACore
* \ingroup nfc
* @{ * @{
* \name Buffer * \name Buffer
* @{ * @{

View File

@ -21,6 +21,7 @@
*/ */
/** \addtogroup NDEF /** \addtogroup NDEF
* \ingroup nfc
* @{ * @{
* \name Generic NDEF Tag * \name Generic NDEF Tag
* @{ * @{

View File

@ -21,7 +21,8 @@
* \details NFC Error codes * \details NFC Error codes
*/ */
/** \addtogroup Core /** \addtogroup nfc-errors Error Codes
* \ingroup nfc
* @{ * @{
* \name Error codes * \name Error codes
* @{ * @{

Some files were not shown because too many files have changed in this diff Show More