Alex Cordonnier / BLE_API

High level Bluetooth Low Energy API and radio abstraction layer

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/BLEProtocol.h

Revision:
1157:a37be30efc66
Parent:
1135:22aada733dbd
Child:
1171:cef71495d95d
--- a/ble/BLEProtocol.h	Wed Apr 06 19:14:38 2016 +0100
+++ b/ble/BLEProtocol.h	Wed Apr 06 19:14:41 2016 +0100
@@ -57,6 +57,14 @@
         AddressType_t  type;    /**< @ref AddressType_t */
         AddressBytes_t address; /**< @ref AddressBytes_t */
 
+        /**
+         * 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);
         }