Update documentation

Co-authored-by: wakwak-koba <[email protected]>

Author: h2zero

docs/BREAKING_API_CHANGES.md

@@ -99,15 +99,17 @@ This can be changed to use passkey authentication or numeric comparison. See [Se
 The `NimBLEAdvertisedDeviceCallbacks::onResult()` method now receives a pointer to the    
 `NimBLEAdvertisedDevice` object instead of a copy.
 
-`NimBLEClient::connect()` now takes an extra parameter to indicate if the client should download the services   
- database from the peripheral, default value is true.
-
+`NimBLEClient::connect()` Has had it's parameters altered.  
 Defined as:
+> NimBLEClient::connect(bool refreshServices = true);  
 > NimBLEClient::connect(NimBLEAdvertisedDevice\* device, bool refreshServices = true);  
-> NimBLEClient::connect(NimBLEAddress address, uint8_t type = BLE_ADDR_PUBLIC, bool refreshServices = true);  
+> NimBLEClient::connect(NimBLEAddress address, bool refreshServices = true);  
+<br/>
 
-If set to false the client will use the services database it retrieved from the peripheral last time it connected.  
-This allows for faster connections and power saving if the devices just dropped connection and want to reconnect.  
+The type parameter has been removed and a new bool parameter has been added to indicate if the client should  
+delete the attribute database previously retrieved (if applicable) for the peripheral, default value is true.  
+If set to false the client will use the attribute database it retrieved from the peripheral when previously connected.  
+This allows for faster connections and power saving if the devices dropped connection and are reconnecting.  
 <br/>
 
 > NimBLERemoteCharacteristic::writeValue();  
@@ -117,6 +119,7 @@ Now return true or false to indicate success or failure so you can choose to dis
 <br/>
 
 > NimBLERemoteCharacteristic::registerForNotify();  
+
 Is now **deprecated**.  
 > NimBLERemoteCharacteristic::subscribe()  
 > NimBLERemoteCharacteristic::unsubscribe()  
@@ -129,7 +132,7 @@ Are the new methods added to replace it.
 > NimBLERemoteCharacteristic::readUInt32()  
 > NimBLERemoteCharacteristic::readFloat()  
 
-Are **deprecated** and NimBLERemoteCharacteristic::readValue(time_t\*, bool) template added to replace them.  
+Are **deprecated** and NimBLERemoteCharacteristic::readValue<type\>(time_t\*, bool) template added to replace them.  
 <br/>
 
 > NimBLERemoteService::getCharacteristicsByHandle()  
@@ -152,8 +155,9 @@ uint8_t *val = (uint8_t*)pChr->readValue().data();
 > NimBLERemoteService::getCharacteristics(bool refresh = false)    
 
 These methods now take an optional (bool) parameter and return a pointer to `std::vector` instead of `std::map`.   
-If passed true it will clear the respective vector and retrieve all the respective attributes from the peripheral.   
-If false(default) it will return the respective vector with the currently stored attributes. 
+If passed true it will clear the respective vector and retrieve **all** the respective attributes from the peripheral.   
+If false(default) it will return the respective vector with the currently stored attributes.  
+<br/>
 
 **Removed:** the automatic discovery of all peripheral attributes as they consumed time and resources for data   
 the user may not be interested in.  
@@ -177,6 +181,17 @@ The client will automatically initiate security when the peripheral responds tha
 The default configuration will use "just-works" pairing with no bonding, if you wish to enable bonding see below.  
 <br/>
 
+# General Differences
+`NimBLEAddress()` When constructing an address the constructor now takes an optional `uint8_t type` paramameter  
+to specify the address type. Default is (0) Public static address.  
+
+Defined as:
+> NimBLEAddress(ble_addr_t address);  
+> NimBLEAddress(uint8_t address[6], uint8_t type = BLE_ADDR_PUBLIC);  
+> NimBLEAddress(const std::string &stringAddress, uint8_t type = BLE_ADDR_PUBLIC);  
+> NimBLEAddress(const uint64_t &address, uint8_t type = BLE_ADDR_PUBLIC);  
+<br/>
+
 # Security Differences
 Security callback functions are now incorporated in the NimBLEServerCallbacks / NimBLEClientCallbacks classes.   
 However backward compatibility with the original `BLESecurity` class is retained to minimize app code changes.  

docs/Improvements_and_updates.md

@@ -87,6 +87,9 @@ NimBLEClient::getService will now retrieve only the service specified and not th
 otherwise wasted retrieving and allocating attributes the user application is not interested in.  
 <br/>
 
+NimBLEClient::connect() can now be called without an address or advertised device parameter. This will connect to the  
+device with the address previously set when last connected or set with NimBLEDevice::setPeerAddress(). 
+
 # General  
 To reduce resource use all instances of std::map have been replaced with std::vector.  
 

src/NimBLEClient.cpp

@@ -152,7 +152,6 @@ bool NimBLEClient::connect(NimBLEAdvertisedDevice* device, bool deleteAttibutes)
 /**
  * @brief Connect to the BLE Server.
  * @param [in] address The address of the server.
- * @param [in] type The address type of the server (Random/public/other)
  * @param [in] deleteAttibutes If true this will delete any attribute objects this client may already\n
  * have created and clears the vectors after successful connection.
  * @return True on success.

src/NimBLEScan.cpp

@@ -161,7 +161,7 @@ void NimBLEScan::setActiveScan(bool active) {
 /**
  * @brief Set whether or not the BLE controller should only report results
  * from devices it has not already seen.
- * @param [in] active If true, scanned devices will only be reported once.
+ * @param [in] enabled If true, scanned devices will only be reported once.
  * @details The controller has a limited buffer and will start reporting
  * dupicate devices once the limit is reached.
  */
@@ -173,7 +173,7 @@ void NimBLEScan::setDuplicateFilter(bool enabled) {
 /**
  * @brief Set whether or not the BLE controller only report scan results
  * from devices advertising in limited discovery mode, i.e. directed advertising.
- * @param [in] active If true, only limited discovery devices will be in scan results.
+ * @param [in] enabled If true, only limited discovery devices will be in scan results.
  */
 void NimBLEScan::setLimitedOnly(bool enabled) {
     m_scan_params.limited = enabled;

src/NimBLEServer.cpp

@@ -534,11 +534,9 @@ void NimBLEServer::removeService(NimBLEService* service, bool deleteSvc) {
 
 /**
  * @brief Adds a service which was already created, but removed from availability.
- *
+ * @param [in] service The service object to add.
  * @note If it is desired to advertise the service it must be added by
  * calling NimBLEAdvertising::addServiceUUID.
- *
- * @param [in} service The service object to add.
  */
 void NimBLEServer::addService(NimBLEService* service) {
     // If adding a service that was not removed just return.

src/NimBLEUUID.cpp

@@ -179,7 +179,7 @@ bool NimBLEUUID::equals(const NimBLEUUID &uuid) const {
  * Create a NimBLEUUID from a string of the form:
  * 0xNNNN
  * 0xNNNNNNNN
- * 0x<UUID>
+ * 0x<UUID\>
  * NNNN
  * NNNNNNNN
  * <UUID\>