more detailed comment for confirmation request

paul-szczepanek-arm · paul-szczepanek-arm · commit 1f52e42bcf44 · 2018-03-01T18:31:16.000Z
diff --git a/features/FEATURE_BLE/ble/SecurityManager.h b/features/FEATURE_BLE/ble/SecurityManager.h
@@ -274,8 +274,11 @@ class SecurityManager {
         }
 
         /**
-         * Indicate to the application that a confirmation is required. The application should
-         * proceed by supplying the confirmation confirmationEntered function.
+         * Indicate to the application that a confirmation is required. This is used
+         * when the device does not have a keyboard but has a yes/no button. The device
+         * displays numbers on its display in response to passkeyDisplay and the user
+         * checks if they are the same on both devices. The application should proceed
+         * by supplying the confirmation using the confirmationEntered function.
          *
          * @param[in] connectionHandle connection connectionHandle
          */

Original file line number	Diff line number	Diff line change
`@@ -274,8 +274,11 @@ class SecurityManager {`
`274`	`274`	`}`
`275`	`275`
`276`	`276`	`/**`
`277`		`- * Indicate to the application that a confirmation is required. The application should`
`278`		`- * proceed by supplying the confirmation confirmationEntered function.`
	`277`	`+ * Indicate to the application that a confirmation is required. This is used`
	`278`	`+ * when the device does not have a keyboard but has a yes/no button. The device`
	`279`	`+ * displays numbers on its display in response to passkeyDisplay and the user`
	`280`	`+ * checks if they are the same on both devices. The application should proceed`
	`281`	`+ * by supplying the confirmation using the confirmationEntered function.`
`279`	`282`	`*`
`280`	`283`	`* @param[in] connectionHandle connection connectionHandle`
`281`	`284`	`*/`