Cristi Stoican / BLE_API

jgh

Dependents:   Migration

Fork of BLE_API by Bluetooth Low Energy

Files at this revision

API Documentation at this revision

Revision 1178:a4418fcb462f, committed 2016-04-06

Comitter:
vcoubard
Date:
Wed Apr 06 19:15:28 2016 +0100
Parent:
1177:f9060dc8c5ab
Child:
1179:4ab722f8dca0
Commit message:
Synchronized with git rev 9e491576
Author: Andres Amaya Garcia
Add doxygen note to BLEInstanceBase class

Changed in this revision

ble/BLEInstanceBase.h Show annotated file Show diff for this revision Revisions of this file 
--- 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
 {