missing documentation, removed privacy call from api

Author: paul-szczepanek-arm

features/FEATURE_BLE/ble/BLETypes.h

@@ -98,8 +98,8 @@ struct attribute_handle_range_t {
 /**
  * Construct an attribute_handle_range_t from its first and last attribute handle.
  *
- * @param begin Handle at the beginning of the range.
- * @param end Handle at the end of the range.
+ * @param[in] begin Handle at the beginning of the range.
+ * @param[in] end Handle at the end of the range.
  *
  * @return An instance of attribute_handle_range_t where
  * attribute_handle_range_t::begin is equal to begin and
@@ -208,7 +208,7 @@ class PasskeyAscii {
     /**
      * Initialize a data from a string.
      *
-     * @param input_value value of the data.
+     * @param[in] passkey value of the data.
      */
     PasskeyAscii(const uint8_t* passkey) {
         if (passkey) {
@@ -221,7 +221,7 @@ class PasskeyAscii {
     /**
      * Initialize a data from a number.
      *
-     * @param input_value value of the data.
+     * @param[in] passkey value of the data.
      */
     PasskeyAscii(passkey_num_t passkey) {
         for (int i = 5, m = 100000; i >= 0; --i, m /= 10) {
@@ -240,7 +240,7 @@ class PasskeyAscii {
 
     /**
      * Convert ASCII string of digits into a number.
-     * @param ASCII string of 6 digits stored as ASCII characters
+     * @param[in] ascii ASCII string of 6 digits stored as ASCII characters
      * @return Passkey as a number.
      */
     static uint32_t to_num(const uint8_t *ascii) {
@@ -273,7 +273,7 @@ struct byte_array_t {
     /**
      * Initialize a data from an array of bytes.
      *
-     * @param input_value value of the data.
+     * @param[in] input_value value of the data.
      */
     byte_array_t(const uint8_t *input_value) {
         memcpy(_value, input_value, sizeof(_value));
@@ -282,8 +282,8 @@ struct byte_array_t {
     /**
      * Initialize a data from an buffer of bytes.
      *
-     * @param input_value pointer to buffer.
-     * @param size buffer size
+     * @param[in] input_value pointer to buffer.
+     * @param[in] size buffer size
      */
     byte_array_t(const uint8_t* input_value, size_t size) {
         memcpy(_value, input_value, size);
@@ -372,7 +372,7 @@ struct address_t : public byte_array_t<6> {
     /**
      * Initialize a data from an array of bytes.
      *
-     * @param input_value value of the data.
+     * @param[in] input_value value of the data.
      */
     address_t(const uint8_t *input_value) {
         memcpy(_value, input_value, sizeof(_value));

features/FEATURE_BLE/ble/Gap.h

@@ -2348,7 +2348,7 @@ class Gap {
      * @param[in] type Advertising type of the packet.
      * @param[in] advertisingDataLen Length of the advertisement data received.
      * @param[in] advertisingData Pointer to the advertisement packet's data.
-     * @param[in] addressType address type of the peer
+     * @param[in] addressType address type of the peer.
      */
     void processAdvertisementReport(
         const BLEProtocol::AddressBytes_t peerAddr,

features/FEATURE_BLE/ble/SecurityManager.h

@@ -141,8 +141,7 @@ class SecurityManager {
         /**
          * Deliver the requested whitelist to the application.
          *
-         * @param[in] whitelist whitelist created based on the bonding table,
-         *                      caller transfers the memory ownership
+         * @param[in] whitelist pointer to the whitelist filled with entries based on bonding information
          */
         virtual void whitelistFromBondTable(Gap::Whitelist_t* whitelist) {
             if (whitelist) {
@@ -372,8 +371,8 @@ class SecurityManager {
      *
      * @param[in] whitelist Preallocated whitelist which will be filled up to its capacity.
      *                      If whitelist already contains entries this will be appended to.
-     *                      Ownership of memory is trasnferred from the caller. It will be
-     *                      returned in the generated event.
+     *                      Do not access the whitelist until callback has been called,
+     *                      returning the filled whitelist.
      *
      * @retval BLE_ERROR_NONE On success, else an error code indicating reason for failure
      */
@@ -571,7 +570,7 @@ class SecurityManager {
      * by a call to linkEncryptionResult in the event handler when the action is completed.
      *
      * @param[in] connectionHandle Handle to identify the connection.
-     * @param[in] encryption
+     * @param[in] encryption encryption state requested
      * @return BLE_ERROR_NONE or appropriate error code indicating the failure reason.
      */
     virtual ble_error_t setLinkEncryption(ble::connection_handle_t connectionHandle, ble::link_encryption_t encryption) {
@@ -584,7 +583,7 @@ class SecurityManager {
      * Return the size of the encryption key used on this link.
      *
      * @param[in] connectionHandle Handle to identify the connection.
-     * @param[out] size Size of the encryption key in bytes
+     * @param[out] byteSize Size of the encryption key in bytes.
      * @return BLE_ERROR_NONE or appropriate error code indicating the failure reason.
      */
     virtual ble_error_t getEncryptionKeySize(ble::connection_handle_t connectionHandle, uint8_t *byteSize) {
@@ -607,21 +606,6 @@ class SecurityManager {
         return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if security is supported. */
     }
 
-    ////////////////////////////////////////////////////////////////////////////
-    // Privacy
-    //
-
-    /**
-     * Set the time after which the private adress will be regenerated.
-     *
-     * @param[in] timeout_in_seconds How often (in seconds) the private address should be regenerated.
-     * @return BLE_ERROR_NONE or appropriate error code indicating the failure reason.
-     */
-    virtual ble_error_t setPrivateAddressTimeout(uint16_t timeout_in_seconds) {
-        (void) timeout_in_seconds;
-        return BLE_ERROR_NOT_IMPLEMENTED; /* Requesting action from porters: override this API if security is supported. */
-    }
-
     ////////////////////////////////////////////////////////////////////////////
     // Authentication
     //
@@ -833,8 +817,8 @@ class SecurityManager {
      *
      * Get the security status of a connection.
      *
-     * @param[in]  connectionHandle   Handle to identify the connection.
-     * @param[out] securityStatusP    Security status.
+     * @param[in]  connectionHandle Handle to identify the connection.
+     * @param[out] securityStatus   Security status.
      *
      * @return BLE_ERROR_NONE or appropriate error code indicating the failure reason.
      */

features/FEATURE_BLE/ble/pal/SecurityDb.h

@@ -367,8 +367,7 @@ class SecurityDb {
 
     /**
      * Asynchronously return a whitelist through a callback, generated from the
-     * bond table. Function takes ownership of the memory. The whitelist and the
-     * ownership will be returned in the callback.
+     * bond table.
      *
      * @param[in] cb callback that will receive the whitelist
      * @param[in] whitelist preallocated whitelist that will be filled in