Alex Cordonnier / BLE_API

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 BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 1168:8289757c0d00, committed 2016-04-06

Comitter:
vcoubard
Date:
Wed Apr 06 19:15:09 2016 +0100
Parent:
1167:91c37c858f48
Child:
1169:39f9a7bdf0a5
Commit message:
Synchronized with git rev 95ac8275
Author: Andres Amaya Garcia
Add missing docs and fix doxy warnings in SecurityManager.h

Changed in this revision

ble/SecurityManager.h Show annotated file Show diff for this revision Revisions of this file 
--- a/ble/SecurityManager.h	Wed Apr 06 19:15:07 2016 +0100
+++ b/ble/SecurityManager.h	Wed Apr 06 19:15:09 2016 +0100
@@ -166,7 +166,7 @@
     /**
      * Get a list of addresses from all peers in the bond table.
      *
-     * @param[in/out]   addresses
+     * @param[in,out]   addresses
      *                  (on input) addresses.capacity contains the maximum
      *                  number of addresses to be returned.
      *                  (on output) The populated table with copies of the
@@ -192,14 +192,14 @@
      * SecurityManager instance is about to shutdown (possibly as a result of a call
      * to BLE::shutdown()).
      *
-     * @Note: It is possible to chain together multiple onShutdown callbacks
+     * @note  It is possible to chain together multiple onShutdown callbacks
      * (potentially from different modules of an application) to be notified
      * before the SecurityManager is shutdown.
      *
-     * @Note: It is also possible to set up a callback into a member function of
+     * @note  It is also possible to set up a callback into a member function of
      * some object.
      *
-     * @Note It is possible to unregister a callback using onShutdown().detach(callback)
+     * @note It is possible to unregister a callback using onShutdown().detach(callback)
      */
     void onShutdown(const SecurityManagerShutdownCallback_t& callback) {
         shutdownCallChain.add(callback);