ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

BLE: Fix doxygen warnings.

pull/5766/merge
Vincent Coubard 2017-12-13 18:08:53 +00:00 committed by Martin Kojtal
parent 3d056df8b6
commit d0205984e2
11 changed files with 28 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
features/FEATURE_BLE/ble/FunctionPointerWithContext.h
View File

@ -77,7 +77,7 @@ public:
* *
* @param[in] object Pointer to the instance which is used to invoke @p * @param[in] object Pointer to the instance which is used to invoke @p
* member. * member.
* @param[in] Pointer to the member function to adapt. * @param[in] member Pointer to the member function to adapt.
*/ */
template<typename T> template<typename T>
FunctionPointerWithContext(T *object, void (T::*member)(ContextType context)) : FunctionPointerWithContext(T *object, void (T::*member)(ContextType context)) :
@ -136,7 +136,7 @@ public:
* operator. * operator.
* *
* @param[in] object Pointer to the instance is used to invoke @p member. * @param[in] object Pointer to the instance is used to invoke @p member.
* @param[in] function Pointer to the member function to adapt. * @param[in] member Pointer to the member function to adapt.
*/ */
template<typename T> template<typename T>
void attach(T *object, void (T::*member)(ContextType context)) void attach(T *object, void (T::*member)(ContextType context))

14
features/FEATURE_BLE/ble/Gap.h
View File

@ -1147,7 +1147,7 @@ public:
* invoked with the @p deviceName parameter set to NULL. * invoked with the @p deviceName parameter set to NULL.
* *
* @param[out] deviceName Pointer to an empty buffer where the UTF-8 * @param[out] deviceName Pointer to an empty buffer where the UTF-8
* <b>non NULL-terminated<b> string is placed. * <b>non NULL-terminated</b> string is placed.
* *
* @param[in,out] lengthP Length of the @p deviceName buffer. If the device * @param[in,out] lengthP Length of the @p deviceName buffer. If the device
* name is successfully copied, then the length of the device name * name is successfully copied, then the length of the device name
@ -1192,7 +1192,7 @@ public:
/** /**
* Get the value of the appearance characteristic in the GAP service. * Get the value of the appearance characteristic in the GAP service.
* *
* @param[out] appearance The current device-appearance value. * @param[out] appearanceP The current device-appearance value.
* *
* @return BLE_ERROR_NONE if the device-appearance was fetched correctly * @return BLE_ERROR_NONE if the device-appearance was fetched correctly
* from the underlying BLE stack. * from the underlying BLE stack.
@ -1265,8 +1265,6 @@ public:
* *
* @return BLE_ERROR_NONE if the implementation's whitelist was successfully * @return BLE_ERROR_NONE if the implementation's whitelist was successfully
* copied into the supplied reference. * copied into the supplied reference.
*
* @experimental
*/ */
virtual ble_error_t getWhitelist(Whitelist_t &whitelist) const virtual ble_error_t getWhitelist(Whitelist_t &whitelist) const
{ {
@ -1284,7 +1282,7 @@ public:
* populated with the addresses in the given whitelist. * populated with the addresses in the given whitelist.
* *
* @note The whitelist must not contain addresses of type @ref * @note The whitelist must not contain addresses of type @ref
* BLEProtocol::AddressType_t::RANDOM_PRIVATE_NON_RESOLVABLE. This * BLEProtocol::AddressType::RANDOM_PRIVATE_NON_RESOLVABLE. This
* results in a @ref BLE_ERROR_INVALID_PARAM because the remote peer might * results in a @ref BLE_ERROR_INVALID_PARAM because the remote peer might
* change its private address at any time, and it is not possible to resolve * change its private address at any time, and it is not possible to resolve
* it. * it.
@ -1971,14 +1969,14 @@ private:
/** /**
* Start the advertising procedure. * Start the advertising procedure.
* *
* @param[in] Advertising parameters to use. * @param[in] params Advertising parameters to use.
* *
* @return BLE_ERROR_NONE if the advertising procedure successfully * @return BLE_ERROR_NONE if the advertising procedure successfully
* started. * started.
* *
* @note Must be implemented in vendor port. * @note Must be implemented in vendor port.
*/ */
virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0; virtual ble_error_t startAdvertising(const GapAdvertisingParams &params) = 0;
public: public:
/** /**
@ -2339,7 +2337,7 @@ public:
* *
* @param[in] peerAddr Address of the peer that has emitted the packet. * @param[in] peerAddr Address of the peer that has emitted the packet.
* @param[in] rssi Value of the RSSI measured for the received packet. * @param[in] rssi Value of the RSSI measured for the received packet.
* @param[in] isScanReponse If true, then the packet is a response to a scan * @param[in] isScanResponse If true, then the packet is a response to a scan
* request. * request.
* @param[in] type Advertising type of the packet. * @param[in] type Advertising type of the packet.
* @param[in] advertisingDataLen Length of the advertisement data received. * @param[in] advertisingDataLen Length of the advertisement data received.

2
features/FEATURE_BLE/ble/SecurityManager.h
View File

@ -175,8 +175,6 @@ public:
* @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure. * @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure.
* @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization or * @retval BLE_ERROR_INVALID_STATE If the API is called without module initialization or
* application registration. * application registration.
*
* @experimental
*/ */
virtual ble_error_t getAddressesFromBondTable(Gap::Whitelist_t &addresses) const { virtual ble_error_t getAddressesFromBondTable(Gap::Whitelist_t &addresses) const {
/* Avoid compiler warnings about unused variables */ /* Avoid compiler warnings about unused variables */

9
features/FEATURE_BLE/ble/services/EddystoneConfigService.h
View File

@ -112,13 +112,16 @@ public:
}; };
/** /**
* @param[ref] ble * @param[in] bleIn
* BLEDevice object for the underlying controller. * BLEDevice object for the underlying controller.
* @param[in/out] paramsIn * @param[in,out] paramsIn
* Reference to application-visible beacon state, loaded * Reference to application-visible beacon state, loaded
* from persistent storage at startup. * from persistent storage at startup.
* @param[in] defaultAdvPowerLevelsIn * @param[in] defaultAdvPowerLevelsIn
* Default power-levels array; applies only if resetToDefaultsFlag is true. * Default power-levels array; applies only if resetToDefaultsFlag is true.
*
* @param[in] radioPowerLevelsIn
* Transmission power-levels to use in TX.
*/ */
EddystoneConfigService(BLEDevice &bleIn, EddystoneConfigService(BLEDevice &bleIn,
Params_t &paramsIn, Params_t &paramsIn,
@ -176,7 +179,7 @@ public:
* @brief Start EddystoneConfig advertising. This function should be called * @brief Start EddystoneConfig advertising. This function should be called
* after the EddystoneConfig constructor and after all the frames have been added. * after the EddystoneConfig constructor and after all the frames have been added.
* *
* @paramsP[in] resetToDefaultsFlag * @param[in] resetToDefaultsFlag
* Applies to the state of the 'paramsIn' parameter. * Applies to the state of the 'paramsIn' parameter.
* If true, it indicates that paramsIn is potentially * If true, it indicates that paramsIn is potentially
* un-initialized, and default values should be used * un-initialized, and default values should be used

3
features/FEATURE_BLE/ble/services/EddystoneService.h
View File

@ -98,6 +98,7 @@ public:
* @param[in] power TX Power in dB measured at 0 meters from the device. Range of -100 to +20 dB. * @param[in] power TX Power in dB measured at 0 meters from the device. Range of -100 to +20 dB.
* @param[in] namespaceID 10B namespace ID * @param[in] namespaceID 10B namespace ID
* @param[in] instanceID 6B instance ID * @param[in] instanceID 6B instance ID
* @param[in] uidAdvPeriodIn Advertising period of UID frames.
* @param[in] RFU 2B of RFU, initialized to 0x0000 and not broadcast, included for future reference. * @param[in] RFU 2B of RFU, initialized to 0x0000 and not broadcast, included for future reference.
*/ */
void setUIDFrameData(int8_t power, void setUIDFrameData(int8_t power,
@ -168,7 +169,7 @@ public:
/** /**
* Set Eddystone URL Frame information. * Set Eddystone URL Frame information.
* @param[in] power TX Power in dB measured at 0 meters from the device. * @param[in] power TX Power in dB measured at 0 meters from the device.
* @param[in] url URL to encode * @param[in] urlIn URL to encode
* @param[in] urlAdvPeriodIn How long to advertise the URL frame (measured in # of adv periods) * @param[in] urlAdvPeriodIn How long to advertise the URL frame (measured in # of adv periods)
* @return false on success, true on failure. * @return false on success, true on failure.
*/ */

5
features/FEATURE_BLE/ble/services/EnvironmentalService.h
View File

@ -35,10 +35,7 @@ public:
/** /**
* @brief EnvironmentalService constructor. * @brief EnvironmentalService constructor.
* @param ble Reference to BLE device. * @param _ble Reference to BLE device.
* @param temperature_en Enable this characteristic.
* @param humidity_en Enable this characteristic.
* @param pressure_en Enable this characteristic.
*/ */
EnvironmentalService(BLE& _ble) : EnvironmentalService(BLE& _ble) :
ble(_ble), ble(_ble),

2
features/FEATURE_BLE/ble/services/HealthThermometerService.h
View File

@ -46,7 +46,7 @@ public:
public: public:
/** /**
* @brief Add the Health Thermometer Service to an existing BLE object, initialize with temperature and location. * @brief Add the Health Thermometer Service to an existing BLE object, initialize with temperature and location.
* @param[ref] _ble Reference to the BLE device. * @param[in] _ble Reference to the BLE device.
* @param[in] initialTemp Initial value in celsius. * @param[in] initialTemp Initial value in celsius.
* @param[in] _location * @param[in] _location
*/ */

2
features/FEATURE_BLE/ble/services/HeartRateService.h
View File

@ -22,7 +22,7 @@
/** /**
* BLE Heart Rate Service. * BLE Heart Rate Service.
* *
* @purpose * @par purpose
* *
* Fitness applications use the heart rate service to expose the heart * Fitness applications use the heart rate service to expose the heart
* beat per minute measured by a heart rate sensor. * beat per minute measured by a heart rate sensor.

4
features/FEATURE_BLE/ble/services/LinkLossService.h
View File

@ -36,8 +36,10 @@ public:
typedef void (* callback_t)(AlertLevel_t level); typedef void (* callback_t)(AlertLevel_t level);
/** /**
* @param[ref] ble * @param bleIn
* BLE object for the underlying controller. * BLE object for the underlying controller.
* @param callbackIn Callback invoked upon disconnection.
* @param levelIn Alert level.
*/ */
LinkLossService(BLE &bleIn, callback_t callbackIn, AlertLevel_t levelIn = NO_ALERT) : LinkLossService(BLE &bleIn, callback_t callbackIn, AlertLevel_t levelIn = NO_ALERT) :
ble(bleIn), ble(bleIn),

4
features/FEATURE_BLE/ble/services/UARTService.h
View File

@ -51,7 +51,7 @@ public:
public: public:
/** /**
* @param[ref] ble * @param _ble
* BLE object for the underlying controller. * BLE object for the underlying controller.
*/ */
UARTService(BLE &_ble) : UARTService(BLE &_ble) :
@ -98,7 +98,7 @@ public:
* a long read request; this is because notifications include only the first * a long read request; this is because notifications include only the first
* 20 bytes of the updated data. * 20 bytes of the updated data.
* *
* @param buffer The received update. * @param _buffer The received update.
* @param length Number of characters to be appended. * @param length Number of characters to be appended.
* @return Number of characters appended to the rxCharacteristic. * @return Number of characters appended to the rxCharacteristic.
*/ */

8
features/FEATURE_BLE/ble/services/URIBeaconConfigService.h
View File

@ -75,17 +75,17 @@ class URIBeaconConfigService {
}; };
/** /**
* @param[ref] ble * @param[in] bleIn
* BLE object for the underlying controller. * BLE object for the underlying controller.
* @param[in/out] paramsIn * @param[in,out] paramsIn
* Reference to application-visible beacon state, loaded * Reference to application-visible beacon state, loaded
* from persistent storage at startup. * from persistent storage at startup.
* @paramsP[in] resetToDefaultsFlag * @param[in] resetToDefaultsFlag
* Applies to the state of the 'paramsIn' parameter. * Applies to the state of the 'paramsIn' parameter.
* If true, it indicates that paramsIn is potentially * If true, it indicates that paramsIn is potentially
* un-initialized, and default values should be used * un-initialized, and default values should be used
* instead. Otherwise, paramsIn overrides the defaults. * instead. Otherwise, paramsIn overrides the defaults.
* @param[in] defaultUriDataIn * @param[in] defaultURIDataIn
* Default un-encoded URI. Applies only if the resetToDefaultsFlag is true. * Default un-encoded URI. Applies only if the resetToDefaultsFlag is true.
* @param[in] defaultAdvPowerLevelsIn * @param[in] defaultAdvPowerLevelsIn
* Default power-levels array. Applies only if the resetToDefaultsFlag is true. * Default power-levels array. Applies only if the resetToDefaultsFlag is true.