Diff: ble/GapScanningParams.h

Revision:

912:f728aa46e7df

Parent:

907:f9a79127973a

Child:

913:690bea02c431

diff -r 885ee648c6ab -r f728aa46e7df ble/GapScanningParams.h
--- a/ble/GapScanningParams.h	Thu Nov 26 12:52:03 2015 +0000
+++ b/ble/GapScanningParams.h	Thu Nov 26 12:52:03 2015 +0000
@@ -19,10 +19,10 @@
 
 class GapScanningParams {
 public:
-    static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625us units - 2.5ms. */
-    static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625us units - 10.24s. */
-    static const unsigned SCAN_WINDOW_MIN   = 0x0004; /**< Minimum Scan window in 625us units - 2.5ms. */
-    static const unsigned SCAN_WINDOW_MAX   = 0x4000; /**< Maximum Scan window in 625us units - 10.24s. */
+    static const unsigned SCAN_INTERVAL_MIN = 0x0004; /**< Minimum Scan interval in 625 us units, i.e. 2.5 ms. */
+    static const unsigned SCAN_INTERVAL_MAX = 0x4000; /**< Maximum Scan interval in 625 us units, i.e. 10.24 s. */
+    static const unsigned SCAN_WINDOW_MIN   = 0x0004; /**< Minimum Scan window in 625 us units, i.e. 2.5 ms. */
+    static const unsigned SCAN_WINDOW_MAX   = 0x4000; /**< Maximum Scan window in 625 us units, i.e. 10.24 s. */
     static const unsigned SCAN_TIMEOUT_MIN  = 0x0001; /**< Minimum Scan timeout in seconds. */
     static const unsigned SCAN_TIMEOUT_MAX  = 0xFFFF; /**< Maximum Scan timeout in seconds. */
 
@@ -46,7 +46,7 @@
     void        setActiveScanning(bool activeScanning);
 
 public:
-    /* @Note: The following return durations in units of 0.625ms */
+    /* @Note: The following return durations in units of 0.625 ms */
     uint16_t getInterval(void) const {return _interval;}
     uint16_t getWindow(void)   const {return _window;  }
 
@@ -54,13 +54,13 @@
     bool     getActiveScanning(void) const {return _activeScanning;}
 
 private:
-    uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms and 10.24s). */
-    uint16_t _window;   /**< Scan window in units of 625us (between 2.5ms and 10.24s). */
-    uint16_t _timeout;  /**< Scan timeout between 0x0001 and 0xFFFF in seconds; 0x0000 disables timeout. */
-    bool     _activeScanning; /**< Obtain the peer device's advertising data and (if possible) scanResponse. */
+    uint16_t _interval; /**< Scan interval in units of 625us (between 2.5ms to 10.24s). */
+    uint16_t _window;   /**< Scan window in units of 625us (between 2.5ms to 10.24s). */
+    uint16_t _timeout;  /**< Scan timeout between 0x0001 and 0xFFFF in seconds, 0x0000 disables timeout. */
+    bool     _activeScanning; /**< obtain not only the advertising data from the peer device, but also their scanResponse if possible. */
 
 private:
-    /* Disallow copy constructor. */
+    /* disallow copy constructor */
     GapScanningParams(const GapScanningParams &);
     GapScanningParams& operator =(const GapScanningParams &in);
 };