Cristi Stoican / BLE_API

jgh

Dependents:   Migration

Fork of BLE_API by Bluetooth Low Energy

Diff: ble/BLEInstanceBase.h

Revision:
1178:a4418fcb462f
Parent:
1156:e1ea38b576c6
Child:
1179:4ab722f8dca0
diff -r f9060dc8c5ab -r a4418fcb462f ble/BLEInstanceBase.h
--- a/ble/BLEInstanceBase.h	Wed Apr 06 19:15:26 2016 +0100
+++ b/ble/BLEInstanceBase.h	Wed Apr 06 19:15:28 2016 +0100
@@ -28,6 +28,10 @@
 /**
  *  The interface for the transport object to be created by the target library's
  *  createBLEInstance().
+ *
+ * @note This class is part of the interface of BLE API with the implementation;
+ *       therefore, it is meant to be used only by porters rather than normal
+ *       BLE API users.
  */
 class BLEInstanceBase
 {