From ae2ff3a6381543e3cfde16e4806bfb28aa2dd55b Mon Sep 17 00:00:00 2001 From: h2zero Date: Sat, 6 Feb 2021 11:12:40 -0700 Subject: [PATCH] Fix Documentation. --- docs/Doxyfile | 8 ++++++-- src/NimBLEDevice.cpp | 8 ++++---- src/NimBLEHIDDevice.cpp | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 71d4482..bf43050 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -2179,8 +2179,12 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = CONFIG_BT_ENABLED \ - _DOXYGEN_ +PREDEFINED = _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 # tag can be used to specify a list of macro names that should be expanded. The diff --git a/src/NimBLEDevice.cpp b/src/NimBLEDevice.cpp index c810e3a..a90f929 100644 --- a/src/NimBLEDevice.cpp +++ b/src/NimBLEDevice.cpp @@ -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: * * ESP_BLE_PWR_TYPE_CONN_HDL0 = 0, For connection handle 0 * * ESP_BLE_PWR_TYPE_CONN_HDL1 = 1, For connection handle 1 @@ -344,7 +344,7 @@ void NimBLEDevice::stopAdvertising() { default: 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. - * @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. * @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. - * @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 Filter by device address only, advertisements from the same address will be reported only once. * * CONFIG_BTDM_SCAN_DUPL_TYPE_DATA (1)\n diff --git a/src/NimBLEHIDDevice.cpp b/src/NimBLEHIDDevice.cpp index 5a35fb2..37d0f52 100644 --- a/src/NimBLEHIDDevice.cpp +++ b/src/NimBLEHIDDevice.cpp @@ -103,7 +103,7 @@ void NimBLEHIDDevice::manufacturer(std::string name) { /** * @brief Sets the Plug n Play characterisc value. * @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] version The produce version number. */