Bkap / 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.

Dependents:   BookAndPlug

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/BLEProtocol.h

Revision:
1183:1589830dbdb7
Parent:
1179:4ab722f8dca0
diff -r b70129080ddf -r 1589830dbdb7 ble/BLEProtocol.h
--- a/ble/BLEProtocol.h	Wed Apr 06 19:15:34 2016 +0100
+++ b/ble/BLEProtocol.h	Wed Apr 06 19:15:36 2016 +0100
@@ -51,16 +51,27 @@
     typedef uint8_t AddressBytes_t[ADDR_LEN]; /**< 48-bit address, in LSB format. */
 
     /**
-     * BLE address. It contains an address-type (@ref AddressType_t) and bytes (@ref AddressBytes_t).
+     * BLE address. It contains an address-type (AddressType_t) and bytes (AddressBytes_t).
      */
     struct Address_t {
-        AddressType_t  type;    /**< @ref AddressType_t */
-        AddressBytes_t address; /**< @ref AddressBytes_t */
+        AddressType_t  type;    /**< The type of the BLE address. */
+        AddressBytes_t address; /**< The BLE address. */
 
+        /**
+         * Construct an Address_t object with the supplied type and address.
+         *
+         * @param[in] typeIn
+         *              The BLE address type.
+         * @param[in] addressIn
+         *              The BLE address.
+         */
         Address_t(AddressType_t typeIn, const AddressBytes_t& addressIn) : type(typeIn) {
             std::copy(addressIn, addressIn + ADDR_LEN, address);
         }
 
+        /**
+         * Empty constructor.
+         */
         Address_t() : type(), address() {
         }
     };