more detail on documentation

dotnet-bluetooth-le#136
JoeErny · Apr 4, 2017 · 6329b0f · 6329b0f
1 parent 2fdd727
commit 6329b0f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -113,9 +113,10 @@ adapter.DeviceDiscovered += (s,a) => deviceList.Add(a.Device);
 await adapter.StartScanningForDevicesAsync();
 ```
 
+##### ScanTimeout
 Set `adapter.ScanTimeout` to specify the maximum duration of the scan.
 
-Set `adapter.ScanMode` to specify scan mode.
+##### ScanMode
 
 #### Connect to device
 `ConnectToDeviceAsync` returns a Task that finishes if the device has been connected successful. Otherwise a `DeviceConnectionException` gets thrown.

diff --git a/Source/Plugin.BLE.Abstractions/Contracts/IAdapter.cs b/Source/Plugin.BLE.Abstractions/Contracts/IAdapter.cs
@@ -49,7 +49,8 @@ public interface IAdapter
         int ScanTimeout { get; set; }
 
         /// <summary>
-        /// Specifies the scanning mode. 
+        /// Specifies the scanning mode. Must be set before calling StartScanningForDevicesAsync().
+        /// Changing it while scanning, will have no change the current scan behavior.
         /// Default: <see cref="ScanMode.LowPower"/> 
         /// </summary>
         ScanMode ScanMode { get; set; }