BLE: Reorganize ble::gap documentation group.

pan- · Nov 26, 2018 · 9621b26 · 9621b26
1 parent 27011fd
commit 9621b26
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 16 deletions.
diff --git a/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h b/features/FEATURE_BLE/ble/gap/AdvertisingDataBuilder.h
@@ -29,15 +29,15 @@
 #include "UUID.h"
 #include "ble/gap/Types.h"
 
+namespace ble {
+
 /**
  * @addtogroup ble
  * @{
  * @addtogroup gap
  * @{
  */
 
-namespace ble {
-
 /*!
  * List of standard Advertising Data types.
  *
@@ -933,12 +933,11 @@ class AdvertisingDataBuilder {
     uint8_t _payload_length;
 };
 
-} // namespace ble
-
 /**
  * @}
  * @}
  */
 
+} // namespace ble
 
 #endif /* ifndef MBED_GAP_ADVERTISING_DATA_H__ */
diff --git a/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h b/features/FEATURE_BLE/ble/gap/AdvertisingParameters.h
@@ -24,15 +24,15 @@
 #include "blecommon.h"
 #include "SafeEnum.h"
 
+namespace ble {
+
 /**
  * @addtogroup ble
  * @{
  * @addtogroup gap
  * @{
  */
 
-namespace ble {
-
 /**
  * Parameters defining the advertising process.
  *
@@ -531,11 +531,11 @@ class AdvertisingParameters {
     bool _includeHeaderTxPower:1;
 };
 
-} // namespace ble
-
 /**
  * @}
  * @}
  */
 
+} // namespace ble
+
 #endif /* ifndef MBED_ADVERTISING_PARAMETERS_H__ */
diff --git a/features/FEATURE_BLE/ble/gap/ConnectionParameters.h b/features/FEATURE_BLE/ble/gap/ConnectionParameters.h
@@ -20,15 +20,15 @@
 #include "ble/BLETypes.h"
 #include "mbed_assert.h"
 
+namespace ble {
+
 /**
  * @addtogroup ble
  * @{
  * @addtogroup gap
  * @{
  */
 
-namespace ble {
-
 /**
  * Parameters defining the connection initiation process.
  *
@@ -453,11 +453,11 @@ class ConnectionParameters {
     bool _enabledPhy[MAX_PARAM_PHYS];
 };
 
-} // namespace ble
-
 /**
  * @}
  * @}
  */
 
+} // namespace ble
+
 #endif /* ifndef MBED_EXTENDED_CONNECT_PARAMETERS_H__ */
diff --git a/features/FEATURE_BLE/ble/gap/Events.h b/features/FEATURE_BLE/ble/gap/Events.h
@@ -23,6 +23,13 @@
 
 namespace ble {
 
+/**
+ * @addtogroup ble
+ * @{
+ * @addtogroup gap
+ * @{
+ */
+
 /**
  * Event generated when an advertising packet is seen during passive scanning
  * or a scan response is received during active scanning.
@@ -805,6 +812,11 @@ struct ConnectionParametersUpdateCompleteEvent {
 
 };
 
+/**
+ * @}
+ * @}
+ */
+
 } // namespace ble
 
 #endif //BLE_GAP_EVENTS_H
diff --git a/features/FEATURE_BLE/ble/gap/Gap.h b/features/FEATURE_BLE/ble/gap/Gap.h
@@ -28,6 +28,13 @@
 
 namespace ble {
 
+/**
+ * @addtogroup ble
+ * @{
+ * @addtogroup gap
+ * @{
+ */
+
 /**
  * Define device discovery, connection and link management procedures.
  *
@@ -1310,6 +1317,11 @@ class Gap {
 #endif
 };
 
+/**
+ * @}
+ * @}
+ */
+
 } // namespace ble
 
 #endif //BLE_GAP_GAP_H
diff --git a/features/FEATURE_BLE/ble/gap/ScanParameters.h b/features/FEATURE_BLE/ble/gap/ScanParameters.h
@@ -21,15 +21,15 @@
 #include "ble/blecommon.h"
 #include "BLETypes.h"
 
+namespace ble {
+
 /**
  * @addtogroup ble
  * @{
  * @addtogroup gap
  * @{
  */
 
-namespace ble {
-
 /**
  * Parameters defining the scan process.
  *
@@ -263,11 +263,11 @@ class ScanParameters {
     phy_configuration_t phy_coded_configuration;
 };
 
-} // namespace ble
-
 /**
  * @}
  * @}
  */
 
+} // namespace ble
+
 #endif /* ifndef MBED_GAP_SCAN_PARAMETERS_H__ */
diff --git a/features/FEATURE_BLE/ble/gap/Types.h b/features/FEATURE_BLE/ble/gap/Types.h
@@ -23,6 +23,13 @@
 
 namespace ble {
 
+/**
+ * @addtogroup ble
+ * @{
+ * @addtogroup gap
+ * @{
+ */
+
 /* BLE units, using microseconds as the common denominator */
 typedef Duration<uint32_t,      625, Range<0x20, 0xFFFFFF> > adv_interval_t;
 typedef Duration<uint16_t,    10000, Range<0x00,   0xFFFF>, Value<uint16_t, 0x0000> > adv_duration_t;
@@ -719,6 +726,10 @@ struct disconnection_reason_t : SafeEnum<disconnection_reason_t, uint8_t> {
     }
 };
 
+/**
+ * @}
+ * @}
+ */
 
 } // namespace ble