From d0205984e2ad407dbf6640dee3cd8f08dffd6cb0 Mon Sep 17 00:00:00 2001 From: Vincent Coubard Date: Wed, 13 Dec 2017 18:08:53 +0000 Subject: [PATCH] BLE: Fix doxygen warnings. --- .../FEATURE_BLE/ble/FunctionPointerWithContext.h | 4 ++-- features/FEATURE_BLE/ble/Gap.h | 14 ++++++-------- features/FEATURE_BLE/ble/SecurityManager.h | 2 -- .../ble/services/EddystoneConfigService.h | 9 ++++++--- .../FEATURE_BLE/ble/services/EddystoneService.h | 3 ++- .../ble/services/EnvironmentalService.h | 5 +---- .../ble/services/HealthThermometerService.h | 2 +- .../FEATURE_BLE/ble/services/HeartRateService.h | 2 +- .../FEATURE_BLE/ble/services/LinkLossService.h | 4 +++- features/FEATURE_BLE/ble/services/UARTService.h | 4 ++-- .../ble/services/URIBeaconConfigService.h | 8 ++++---- 11 files changed, 28 insertions(+), 29 deletions(-) diff --git a/features/FEATURE_BLE/ble/FunctionPointerWithContext.h b/features/FEATURE_BLE/ble/FunctionPointerWithContext.h index cca90695aa..83507b7715 100644 --- a/features/FEATURE_BLE/ble/FunctionPointerWithContext.h +++ b/features/FEATURE_BLE/ble/FunctionPointerWithContext.h @@ -77,7 +77,7 @@ public: * * @param[in] object Pointer to the instance which is used to invoke @p * member. - * @param[in] Pointer to the member function to adapt. + * @param[in] member Pointer to the member function to adapt. */ template FunctionPointerWithContext(T *object, void (T::*member)(ContextType context)) : @@ -136,7 +136,7 @@ public: * operator. * * @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 void attach(T *object, void (T::*member)(ContextType context)) diff --git a/features/FEATURE_BLE/ble/Gap.h b/features/FEATURE_BLE/ble/Gap.h index d1b9c768db..f9b5bdbe34 100644 --- a/features/FEATURE_BLE/ble/Gap.h +++ b/features/FEATURE_BLE/ble/Gap.h @@ -1147,7 +1147,7 @@ public: * invoked with the @p deviceName parameter set to NULL. * * @param[out] deviceName Pointer to an empty buffer where the UTF-8 - * non NULL-terminated string is placed. + * non NULL-terminated string is placed. * * @param[in,out] lengthP Length of the @p deviceName buffer. If the device * 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. * - * @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 * from the underlying BLE stack. @@ -1265,8 +1265,6 @@ public: * * @return BLE_ERROR_NONE if the implementation's whitelist was successfully * copied into the supplied reference. - * - * @experimental */ virtual ble_error_t getWhitelist(Whitelist_t &whitelist) const { @@ -1284,7 +1282,7 @@ public: * populated with the addresses in the given whitelist. * * @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 * change its private address at any time, and it is not possible to resolve * it. @@ -1971,14 +1969,14 @@ private: /** * 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 * started. * * @note Must be implemented in vendor port. */ - virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0; + virtual ble_error_t startAdvertising(const GapAdvertisingParams ¶ms) = 0; public: /** @@ -2339,7 +2337,7 @@ public: * * @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] 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. * @param[in] type Advertising type of the packet. * @param[in] advertisingDataLen Length of the advertisement data received. diff --git a/features/FEATURE_BLE/ble/SecurityManager.h b/features/FEATURE_BLE/ble/SecurityManager.h index 955d88c8e0..f2077561d1 100644 --- a/features/FEATURE_BLE/ble/SecurityManager.h +++ b/features/FEATURE_BLE/ble/SecurityManager.h @@ -175,8 +175,6 @@ public: * @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 * application registration. - * - * @experimental */ virtual ble_error_t getAddressesFromBondTable(Gap::Whitelist_t &addresses) const { /* Avoid compiler warnings about unused variables */ diff --git a/features/FEATURE_BLE/ble/services/EddystoneConfigService.h b/features/FEATURE_BLE/ble/services/EddystoneConfigService.h index 8bebe509f4..f21bd13a50 100644 --- a/features/FEATURE_BLE/ble/services/EddystoneConfigService.h +++ b/features/FEATURE_BLE/ble/services/EddystoneConfigService.h @@ -112,13 +112,16 @@ public: }; /** - * @param[ref] ble + * @param[in] bleIn * BLEDevice object for the underlying controller. - * @param[in/out] paramsIn + * @param[in,out] paramsIn * Reference to application-visible beacon state, loaded * from persistent storage at startup. * @param[in] defaultAdvPowerLevelsIn * Default power-levels array; applies only if resetToDefaultsFlag is true. + * + * @param[in] radioPowerLevelsIn + * Transmission power-levels to use in TX. */ EddystoneConfigService(BLEDevice &bleIn, Params_t ¶msIn, @@ -176,7 +179,7 @@ public: * @brief Start EddystoneConfig advertising. This function should be called * 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. * If true, it indicates that paramsIn is potentially * un-initialized, and default values should be used diff --git a/features/FEATURE_BLE/ble/services/EddystoneService.h b/features/FEATURE_BLE/ble/services/EddystoneService.h index 6d92cf8a0f..c88a8a4791 100644 --- a/features/FEATURE_BLE/ble/services/EddystoneService.h +++ b/features/FEATURE_BLE/ble/services/EddystoneService.h @@ -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] namespaceID 10B namespace 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. */ void setUIDFrameData(int8_t power, @@ -168,7 +169,7 @@ public: /** * Set Eddystone URL Frame information. * @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) * @return false on success, true on failure. */ diff --git a/features/FEATURE_BLE/ble/services/EnvironmentalService.h b/features/FEATURE_BLE/ble/services/EnvironmentalService.h index 774cc4a30f..c081245beb 100644 --- a/features/FEATURE_BLE/ble/services/EnvironmentalService.h +++ b/features/FEATURE_BLE/ble/services/EnvironmentalService.h @@ -35,10 +35,7 @@ public: /** * @brief EnvironmentalService constructor. - * @param ble Reference to BLE device. - * @param temperature_en Enable this characteristic. - * @param humidity_en Enable this characteristic. - * @param pressure_en Enable this characteristic. + * @param _ble Reference to BLE device. */ EnvironmentalService(BLE& _ble) : ble(_ble), diff --git a/features/FEATURE_BLE/ble/services/HealthThermometerService.h b/features/FEATURE_BLE/ble/services/HealthThermometerService.h index 5eb7178244..af06b59f5d 100644 --- a/features/FEATURE_BLE/ble/services/HealthThermometerService.h +++ b/features/FEATURE_BLE/ble/services/HealthThermometerService.h @@ -46,7 +46,7 @@ public: public: /** * @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] _location */ diff --git a/features/FEATURE_BLE/ble/services/HeartRateService.h b/features/FEATURE_BLE/ble/services/HeartRateService.h index 959ef65cde..e8e239361c 100644 --- a/features/FEATURE_BLE/ble/services/HeartRateService.h +++ b/features/FEATURE_BLE/ble/services/HeartRateService.h @@ -22,7 +22,7 @@ /** * BLE Heart Rate Service. * - * @purpose + * @par purpose * * Fitness applications use the heart rate service to expose the heart * beat per minute measured by a heart rate sensor. diff --git a/features/FEATURE_BLE/ble/services/LinkLossService.h b/features/FEATURE_BLE/ble/services/LinkLossService.h index beb44c2052..9bfed115e5 100644 --- a/features/FEATURE_BLE/ble/services/LinkLossService.h +++ b/features/FEATURE_BLE/ble/services/LinkLossService.h @@ -36,8 +36,10 @@ public: typedef void (* callback_t)(AlertLevel_t level); /** - * @param[ref] ble + * @param bleIn * 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) : ble(bleIn), diff --git a/features/FEATURE_BLE/ble/services/UARTService.h b/features/FEATURE_BLE/ble/services/UARTService.h index e8701ab155..43da23c6f9 100644 --- a/features/FEATURE_BLE/ble/services/UARTService.h +++ b/features/FEATURE_BLE/ble/services/UARTService.h @@ -51,7 +51,7 @@ public: public: /** - * @param[ref] ble + * @param _ble * BLE object for the underlying controller. */ UARTService(BLE &_ble) : @@ -98,7 +98,7 @@ public: * a long read request; this is because notifications include only the first * 20 bytes of the updated data. * - * @param buffer The received update. + * @param _buffer The received update. * @param length Number of characters to be appended. * @return Number of characters appended to the rxCharacteristic. */ diff --git a/features/FEATURE_BLE/ble/services/URIBeaconConfigService.h b/features/FEATURE_BLE/ble/services/URIBeaconConfigService.h index db63707f3c..9eb95bd40c 100644 --- a/features/FEATURE_BLE/ble/services/URIBeaconConfigService.h +++ b/features/FEATURE_BLE/ble/services/URIBeaconConfigService.h @@ -75,17 +75,17 @@ class URIBeaconConfigService { }; /** - * @param[ref] ble + * @param[in] bleIn * BLE object for the underlying controller. - * @param[in/out] paramsIn + * @param[in,out] paramsIn * Reference to application-visible beacon state, loaded * from persistent storage at startup. - * @paramsP[in] resetToDefaultsFlag + * @param[in] resetToDefaultsFlag * Applies to the state of the 'paramsIn' parameter. * If true, it indicates that paramsIn is potentially * un-initialized, and default values should be used * instead. Otherwise, paramsIn overrides the defaults. - * @param[in] defaultUriDataIn + * @param[in] defaultURIDataIn * Default un-encoded URI. Applies only if the resetToDefaultsFlag is true. * @param[in] defaultAdvPowerLevelsIn * Default power-levels array. Applies only if the resetToDefaultsFlag is true.