BLE: doxygen fixes.

pull/8738/head
Vincent Coubard 2018-11-25 13:48:26 +00:00
parent 0407ee8c81
commit be7cc41da4
3 changed files with 13 additions and 5 deletions

View File

@ -321,6 +321,10 @@ void set_all_zeros(byte_array_class &byte_array) {
memset(&byte_array[0], 0x00, byte_array.size());
}
/**
* Model fixed size array values.
* @tparam array_size The size of the array.
*/
template <size_t array_size>
struct byte_array_t {
/**

View File

@ -539,7 +539,12 @@ struct adv_data_appearance_t : SafeEnum<adv_data_appearance_t, uint16_t> {
}
};
/**
* Build advertising data.
*
* The builder accept an array of bytes in input and returns the result of the
* construction with getAdvertisingData().
*/
class AdvertisingDataBuilder {
public:
/** Advertising data needs a user provided buffer to store the data.
@ -774,7 +779,6 @@ public:
*
* @param[in] service UUID of the service.
* @param[in] data New data to be added.
* @param[in] complete True if this is a complete list.
*
* @retval BLE_ERROR_NONE on success.
* @retval BLE_ERROR_BUFFER_OVERFLOW if buffer is too small to contain the new data.

View File

@ -184,7 +184,7 @@ public:
/** Set the advertising intervals on the primary channels.
*
* @param[in] minInterval, maxInterval Time interval between two advertisement.
* @param[in] min, max Time interval between two advertisement.
* A range is provided to the LE subsystem so it can adjust the advertising
* interval with other transmission happening on the BLE radio.
*
@ -325,7 +325,7 @@ public:
/** Set the filter policy of whitelist use during advertising;
*
* @param Policy to use.
* @param mode Policy to use.
*
* @return A reference to this object.
*/
@ -427,7 +427,7 @@ public:
*
* @return A reference to this object.
*
* @see ::ble::Gap::EventHandler::onScanRequest()
* @see ::ble::Gap::EventHandler::onScanRequestReceived()
*/
AdvertisingParameters &setScanRequestNotification(bool enable = true)
{