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

* Clean up group definitions in doxygen * remove THIRD_PARTY_DOCS * some stragglers * fix astyle formatting
Jookia · Nov 13, 2022 · 961632a · 961632a
1 parent e4469c3
commit 961632a
Show file tree

Hide file tree

Showing 134 changed files with 293 additions and 472 deletions.
diff --git a/connectivity/FEATURE_BLE/include/ble/BLE.h b/connectivity/FEATURE_BLE/include/ble/BLE.h
@@ -475,15 +475,16 @@ class BLE {
     bool event_signaled;
 };
 
-}
 
-using ble::BLE;
 /**
- * @namespace ble Entry namespace for all BLE API definitions.
+ * @}
  */
 
+}
+
+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
@@ -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
@@ -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/...URE_BLE/libraries/TARGET_CORDIO_LL/stack/thirdparty/nordic-bsp/components/boards/boards.h b/...URE_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
@@ -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
@@ -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 @@ class CellularContext : public CellularInterface {
 };
 
 /**
+ * @}
  * @}
  */
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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 @@ class AT_CellularContext : public CellularContext {
     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
@@ -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 @@ class AT_CellularDevice : public CellularDevice {
     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
@@ -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 @@ class AT_CellularInformation : public CellularInformation {
     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
@@ -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 @@ class AT_CellularNetwork : public CellularNetwork {
     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
@@ -26,8 +26,15 @@
 #include "AT_CellularDevice.h"
 #include <time.h>
 
+
 namespace mbed {
 
+/**
+ * @addtogroup at-hayes AT/Hayes Command Set
+ * @ingroup Cellular
+ * @{
+ */
+
 /**
  *  Class AT_CellularSMS
  *
@@ -171,6 +178,10 @@ class AT_CellularSMS: public CellularSMS {
     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
@@ -23,8 +23,15 @@
 #include "rtos/Mutex.h"
 #include "AT_CellularDevice.h"
 
+
 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.
 // 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 @@ class AT_CellularStack : public NetworkStack {
     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
@@ -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 @@ class AT_ControlPlane_netif: public ControlPlane_netif {
     AT_CellularDevice &_device;
 };
 
+/**
+ * @}
+ */
+
 } //mbed namespace
diff --git a/...tivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm.h b/...tivity/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/.../drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_aesccm_error.h b/.../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
diff --git a/...tivity/drivers/mbedtls/FEATURE_CRYPTOCELL310/include/cryptocell310/internal/crys_chacha.h b/...tivity/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 */