Add missing documentation to getAddressesFromBondTable API

7 years ago · 33db258c8d
parent 116eb8db8e
commit 33db258c8d
1 changed files with 4 additions and 2 deletions
--- a/source/nRF5xSecurityManager.h
+++ b/source/nRF5xSecurityManager.h
@ -50,8 +50,10 @@ public:
     * @brief  Returns a list of addresses from peers in the stacks bond table.
     *
     * @param[in/out]   addresses
-     *                  (on input)
-     *                  (on output)
+     *                  (on input) @ref Gap::Whitelist_t structure where at
+     *                  most addresses.capacity addresses from bonded peers will
+     *                  be stored.
+     *                  (on output) A copy of the addresses from bonded peers.
     *
     * @return
     *           BLE_ERROR_NONE if successful.