Revision 1169:39f9a7bdf0a5, committed 2016-04-06

Comitter:

vcoubard

Date:

Wed Apr 06 19:15:10 2016 +0100

Parent:

1168:8289757c0d00

Child:

1170:e8f2db0e8e11

Commit message:

Synchronized with git rev 9d62d21e
Author: Andres Amaya Garcia
Add missing docs and fix doxy warnings in ServiceDiscovery.h

Changed in this revision

--- a/ble/ServiceDiscovery.h	Wed Apr 06 19:15:09 2016 +0100
+++ b/ble/ServiceDiscovery.h	Wed Apr 06 19:15:10 2016 +0100
@@ -117,7 +117,7 @@
                                const UUID               &matchingCharacteristicUUIDIn = UUID::ShortUUIDBytes_t(BLE_UUID_UNKNOWN)) = 0;
 
     /**
-     * Is service-discovery currently active?
+     * Check whether service-discovery is currently active.
      */
     virtual bool        isActive(void) const = 0;
 
@@ -154,11 +154,30 @@
     }
 
 protected:
-    Gap::Handle_t            connHandle; /**< Connection handle as provided by the SoftDevice. */
+    /**
+     * Connection handle as provided by the SoftDevice.
+     */
+    Gap::Handle_t            connHandle;
+    /**
+     * UUID-based filter that specifies the service that the application is
+     * interested in.
+     */
     UUID                     matchingServiceUUID;
+    /**
+     * The registered callback handle for when a matching service is found
+     * during service-discovery.
+     */
     ServiceCallback_t        serviceCallback;
+    /**
+     * UUID-based filter that specifies the characteristic that the
+     * application is interested in.
+     */
     UUID                     matchingCharacteristicUUID;
+    /**
+     * The registered callback handler for when a matching characteristic is
+     * found during service-discovery.
+     */
     CharacteristicCallback_t characteristicCallback;
 };
 
-#endif // ifndef __SERVICE_DISOVERY_H__
\ No newline at end of file
+#endif /* ifndef __SERVICE_DISOVERY_H__ */
\ No newline at end of file