Shuta Nakamae / nRF51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of nRF51822 by Nordic Semiconductor

Diff: source/btle/btle_security.h

Revision:
599:3e66e1eb264d
Parent:
598:814c1ce92947
Child:
600:0978b5626451
diff -r 814c1ce92947 -r 3e66e1eb264d source/btle/btle_security.h
--- a/source/btle/btle_security.h	Mon Jan 11 10:19:35 2016 +0000
+++ b/source/btle/btle_security.h	Mon Jan 11 10:19:36 2016 +0000
@@ -77,8 +77,25 @@
  */
 ble_error_t btle_purgeAllBondingState(void);
 
+/**
+ * Function to test whether the SecurityManager has been initialized.
+ * Possible by a call to @ref btle_initializeSecurity().
+ *
+ * @return True if the SecurityManager was previously initialized, false
+ *         otherwise.
+ */
 bool btle_hasInitializedSecurity(void);
 
+/**
+ * Function to test whether a BLE address is generated using an IRK.
+ *
+ * @param[in]   p_addr
+ *                  Pointer to a BLE address.
+ * @param[in]   p_irk
+ *                  Pointer to an IRK.
+ *
+ * @return True if p_addr can be generated using p_irk, false otherwise.
+ */
 bool btle_matchAddressAndIrk(ble_gap_addr_t const * p_addr, ble_gap_irk_t const * p_irk);
 
 #endif /* _BTLE_SECURITY_H_ */
\ No newline at end of file