From 3a4a4c16feea3b6a67a8f3e5f3d8dc1cabc4ff83 Mon Sep 17 00:00:00 2001
From: Rohit Grover <rohit.grover@arm.com>
Date: Fri, 19 Jun 2015 09:48:09 +0100
Subject: [PATCH] SecurityManager: fix comments.

---
 public/SecurityManager.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/public/SecurityManager.h b/public/SecurityManager.h
index 3ece591..823adca 100644
--- a/public/SecurityManager.h
+++ b/public/SecurityManager.h
@@ -82,6 +82,9 @@ public:
     typedef void (*LinkSecuredCallback_t)(Gap::Handle_t handle, SecurityMode_t securityMode);
     typedef void (*PasskeyDisplayCallback_t)(Gap::Handle_t handle, const Passkey_t passkey);
 
+    /*
+     * The following functions are meant to be overridden in the platform-specific sub-class.
+     */
 public:
     /**
      * Enable the BLE stack's Security Manager. The Security Manager implements
@@ -129,6 +132,7 @@ public:
         return BLE_ERROR_NOT_IMPLEMENTED; /* default implementation; override this if security is supported. */
     }
 
+    /* Event callback handlers. */
 public:
     /**
      * To indicate that security procedure for link has started.
@@ -158,6 +162,7 @@ public:
      */
     virtual void onPasskeyDisplay(PasskeyDisplayCallback_t callback) {passkeyDisplayCallback = callback;}
 
+    /* Entry points for the underlying stack to report events back to the user. */
 public:
     void processSecuritySetupInitiatedEvent(Gap::Handle_t handle, bool allowBonding, bool requireMITM, SecurityIOCapabilities_t iocaps) {
         if (securitySetupInitiatedCallback) {
@@ -199,7 +204,6 @@ protected:
         /* empty */
     }
 
-
 protected:
     SecuritySetupInitiatedCallback_t securitySetupInitiatedCallback;
     SecuritySetupCompletedCallback_t securitySetupCompletedCallback;