ScStw/esp-nimble-cpp
2
0
Fork 0
mirror of https://github.com/h2zero/esp-nimble-cpp.git synced 2024-11-22 05:00:55 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix Documentation.

Browse source
This commit is contained in:
h2zero 2021-02-06 11:12:40 -07:00
parent 43c9d96373
commit ae2ff3a638
3 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/Doxyfile
View file

@ -2179,8 +2179,12 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator. # recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = CONFIG_BT_ENABLED \ PREDEFINED = _DOXYGEN_ \
_DOXYGEN_ CONFIG_BT_ENABLED \
CONFIG_BT_NIMBLE_ROLE_CENTRAL \
CONFIG_BT_NIMBLE_ROLE_OBSERVER \
CONFIG_BT_NIMBLE_ROLE_PERIPHERAL \
CONFIG_BT_NIMBLE_ROLE_BROADCASTER
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The # tag can be used to specify a list of macro names that should be expanded. The

8
src/NimBLEDevice.cpp
View file

@ -305,7 +305,7 @@ void NimBLEDevice::stopAdvertising() {
/** /**
* @brief Set the transmission power. * @brief Get the transmission power.
* @param [in] powerType The power level to set, can be one of: * @param [in] powerType The power level to set, can be one of:
* * ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, For connection handle 0 * * ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, For connection handle 0
* * ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, For connection handle 1 * * ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, For connection handle 1
@ -344,7 +344,7 @@ void NimBLEDevice::stopAdvertising() {
default: default:
return BLE_HS_ADV_TX_PWR_LVL_AUTO; return BLE_HS_ADV_TX_PWR_LVL_AUTO;
} }
} // setPower } // getPower
/** /**
@ -404,7 +404,7 @@ void NimBLEDevice::stopAdvertising() {
/** /**
* @brief Set the duplicate filter mode for filtering scanned devices. * @brief Set the duplicate filter mode for filtering scanned devices.
* @param {in] cacheSize The number of advertisements filtered before the cache is reset.\n * @param [in] cacheSize The number of advertisements filtered before the cache is reset.\n
* Range is 10-1000, a larger value will reduce how often the same devices are reported. * Range is 10-1000, a larger value will reduce how often the same devices are reported.
* @details Must only be called before calling NimBLEDevice::init. * @details Must only be called before calling NimBLEDevice::init.
*/ */
@ -424,7 +424,7 @@ void NimBLEDevice::setScanDuplicateCacheSize(uint16_t cacheSize) {
/** /**
* @brief Set the duplicate filter mode for filtering scanned devices. * @brief Set the duplicate filter mode for filtering scanned devices.
* @param {in] mode One of three possible options: * @param [in] mode One of three possible options:
* * CONFIG_BTDM_SCAN_DUPL_TYPE_DEVICE (0) (default)\n * * CONFIG_BTDM_SCAN_DUPL_TYPE_DEVICE (0) (default)\n
Filter by device address only, advertisements from the same address will be reported only once. Filter by device address only, advertisements from the same address will be reported only once.
* * CONFIG_BTDM_SCAN_DUPL_TYPE_DATA (1)\n * * CONFIG_BTDM_SCAN_DUPL_TYPE_DATA (1)\n

2
src/NimBLEHIDDevice.cpp
View file

@ -103,7 +103,7 @@ void NimBLEHIDDevice::manufacturer(std::string name) {
/** /**
* @brief Sets the Plug n Play characterisc value. * @brief Sets the Plug n Play characterisc value.
* @param [in] sig The vendor ID source number. * @param [in] sig The vendor ID source number.
* @param [in[ vid The vendor ID number. * @param [in] vid The vendor ID number.
* @param [in] pid The product ID number. * @param [in] pid The product ID number.
* @param [in] version The produce version number. * @param [in] version The produce version number.
*/ */