Diff: public/BLEDevice.h

Revision:

412:cf2cce37ad73

Parent:

411:af8f2d1b67b6

Child:

413:7a295e110b77

--- a/public/BLEDevice.h	Mon Jun 08 10:41:17 2015 +0100
+++ b/public/BLEDevice.h	Mon Jun 08 10:41:18 2015 +0100
@@ -33,8 +33,16 @@
     /**
      * Initialize the BLE controller. This should be called before using
      * anything else in the BLE_API.
+     *
+     * init() hands control to the underlying BLE module to accomplish
+     * initialization. This initialization may tacitly depend on other hardware
+     * setup (such as clocks or power-modes) which happens early on during
+     * system startup. It may not be safe to call init() from global static
+     * context where ordering is compiler specific and can't be guaranteed--it
+     * is safe to call BLEDevice::init() from within main().
      */
     ble_error_t init();
+
     ble_error_t reset(void);
 
     /**