BLE: Reorganize ble::gap documentation group.

pull/8738/head
Vincent Coubard 2018-11-25 10:06:43 +00:00
parent 27011fd954
commit 9621b26cab
7 changed files with 50 additions and 16 deletions

View File

@ -29,6 +29,8 @@
#include "UUID.h" #include "UUID.h"
#include "ble/gap/Types.h" #include "ble/gap/Types.h"
namespace ble {
/** /**
* @addtogroup ble * @addtogroup ble
* @{ * @{
@ -36,8 +38,6 @@
* @{ * @{
*/ */
namespace ble {
/*! /*!
* List of standard Advertising Data types. * List of standard Advertising Data types.
* *
@ -933,12 +933,11 @@ private:
uint8_t _payload_length; uint8_t _payload_length;
}; };
} // namespace ble
/** /**
* @} * @}
* @} * @}
*/ */
} // namespace ble
#endif /* ifndef MBED_GAP_ADVERTISING_DATA_H__ */ #endif /* ifndef MBED_GAP_ADVERTISING_DATA_H__ */

View File

@ -24,6 +24,8 @@
#include "blecommon.h" #include "blecommon.h"
#include "SafeEnum.h" #include "SafeEnum.h"
namespace ble {
/** /**
* @addtogroup ble * @addtogroup ble
* @{ * @{
@ -31,8 +33,6 @@
* @{ * @{
*/ */
namespace ble {
/** /**
* Parameters defining the advertising process. * Parameters defining the advertising process.
* *
@ -531,11 +531,11 @@ private:
bool _includeHeaderTxPower:1; bool _includeHeaderTxPower:1;
}; };
} // namespace ble
/** /**
* @} * @}
* @} * @}
*/ */
} // namespace ble
#endif /* ifndef MBED_ADVERTISING_PARAMETERS_H__ */ #endif /* ifndef MBED_ADVERTISING_PARAMETERS_H__ */

View File

@ -20,6 +20,8 @@
#include "ble/BLETypes.h" #include "ble/BLETypes.h"
#include "mbed_assert.h" #include "mbed_assert.h"
namespace ble {
/** /**
* @addtogroup ble * @addtogroup ble
* @{ * @{
@ -27,8 +29,6 @@
* @{ * @{
*/ */
namespace ble {
/** /**
* Parameters defining the connection initiation process. * Parameters defining the connection initiation process.
* *
@ -453,11 +453,11 @@ private:
bool _enabledPhy[MAX_PARAM_PHYS]; bool _enabledPhy[MAX_PARAM_PHYS];
}; };
} // namespace ble
/** /**
* @} * @}
* @} * @}
*/ */
} // namespace ble
#endif /* ifndef MBED_EXTENDED_CONNECT_PARAMETERS_H__ */ #endif /* ifndef MBED_EXTENDED_CONNECT_PARAMETERS_H__ */

View File

@ -23,6 +23,13 @@
namespace ble { namespace ble {
/**
* @addtogroup ble
* @{
* @addtogroup gap
* @{
*/
/** /**
* Event generated when an advertising packet is seen during passive scanning * Event generated when an advertising packet is seen during passive scanning
* or a scan response is received during active scanning. * or a scan response is received during active scanning.
@ -805,6 +812,11 @@ private:
}; };
/**
* @}
* @}
*/
} // namespace ble } // namespace ble
#endif //BLE_GAP_EVENTS_H #endif //BLE_GAP_EVENTS_H

View File

@ -28,6 +28,13 @@
namespace ble { namespace ble {
/**
* @addtogroup ble
* @{
* @addtogroup gap
* @{
*/
/** /**
* Define device discovery, connection and link management procedures. * Define device discovery, connection and link management procedures.
* *
@ -1310,6 +1317,11 @@ protected:
#endif #endif
}; };
/**
* @}
* @}
*/
} // namespace ble } // namespace ble
#endif //BLE_GAP_GAP_H #endif //BLE_GAP_GAP_H

View File

@ -21,6 +21,8 @@
#include "ble/blecommon.h" #include "ble/blecommon.h"
#include "BLETypes.h" #include "BLETypes.h"
namespace ble {
/** /**
* @addtogroup ble * @addtogroup ble
* @{ * @{
@ -28,8 +30,6 @@
* @{ * @{
*/ */
namespace ble {
/** /**
* Parameters defining the scan process. * Parameters defining the scan process.
* *
@ -263,11 +263,11 @@ private:
phy_configuration_t phy_coded_configuration; phy_configuration_t phy_coded_configuration;
}; };
} // namespace ble
/** /**
* @} * @}
* @} * @}
*/ */
} // namespace ble
#endif /* ifndef MBED_GAP_SCAN_PARAMETERS_H__ */ #endif /* ifndef MBED_GAP_SCAN_PARAMETERS_H__ */

View File

@ -23,6 +23,13 @@
namespace ble { namespace ble {
/**
* @addtogroup ble
* @{
* @addtogroup gap
* @{
*/
/* BLE units, using microseconds as the common denominator */ /* BLE units, using microseconds as the common denominator */
typedef Duration<uint32_t, 625, Range<0x20, 0xFFFFFF> > adv_interval_t; 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; 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 } // namespace ble