Joshua Slater / BLE_API2

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Comitter:
rgrover1
Date:
Fri Jun 19 15:52:00 2015 +0100
Parent:
473:d10415d0a07d
Child:
475:eb7fbcfb0e85
Commit message:
Synchronized with git rev 9f54d528
Author: Rohit Grover
add some comment headers

Changed in this revision

public/ServiceDiscovery.h Show annotated file Show diff for this revision Revisions of this file
--- a/public/ServiceDiscovery.h	Fri Jun 19 15:51:59 2015 +0100
+++ b/public/ServiceDiscovery.h	Fri Jun 19 15:52:00 2015 +0100
@@ -36,9 +36,20 @@
                               const UUID               &matchingServiceUUID = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN),
                               const UUID               &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN));
 
+    /**
+     * Terminate an ongoing service-discovery. This should result in an
+     * invocation of the TerminationCallback if service-discovery is active.
+     */
     static void        terminate(void);
 
+    /**
+     * Is service-discovery currently active?
+     */
     static bool        isActive(void);
+
+    /**
+     * Setup callback to be invoked when service discovery is terminated.
+     */
     static void        onTermination(TerminationCallback_t callback);
 
 protected: