lp ticker wrapper: Add undefined behavior warning

Filip Jagodzinski · Filip Jagodzinski · commit effabc5271a5 · 2018-10-19T17:32:31.000+02:00
diff --git a/hal/LowPowerTickerWrapper.h b/hal/LowPowerTickerWrapper.h
@@ -74,6 +74,9 @@ class LowPowerTickerWrapper {
      *
      * This stops to wrapper layer from using the microsecond ticker.
      * This should be called before using the low power ticker APIs directly.
+     *
+     * @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),
+     * otherwise the behavior is undefined.
      */
     void suspend();
 
diff --git a/hal/mbed_lp_ticker_wrapper.h b/hal/mbed_lp_ticker_wrapper.h
@@ -53,6 +53,9 @@ const ticker_data_t *get_lp_ticker_wrapper_data(const ticker_data_t *data);
  *
  * Pass through all interrupts to the low power ticker and stop using
  * the microsecond ticker.
+ *
+ * @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),
+ * otherwise the behavior is undefined.
  */
 void lp_ticker_wrapper_suspend(void);
 

Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,9 @@ class LowPowerTickerWrapper {`
`74`	`74`	`*`
`75`	`75`	`* This stops to wrapper layer from using the microsecond ticker.`
`76`	`76`	`* This should be called before using the low power ticker APIs directly.`
	`77`	`+ *`
	`78`	`+ * @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),`
	`79`	`+ * otherwise the behavior is undefined.`
`77`	`80`	`*/`
`78`	`81`	`void suspend();`
`79`	`82`
Original file line number	Diff line number	Diff line change
`@@ -53,6 +53,9 @@ const ticker_data_t get_lp_ticker_wrapper_data(const ticker_data_t data);`
`53`	`53`	`*`
`54`	`54`	`* Pass through all interrupts to the low power ticker and stop using`
`55`	`55`	`* the microsecond ticker.`
	`56`	`+ *`
	`57`	`+ * @warning: Make sure to suspend the LP ticker first (call ticker_suspend()),`
	`58`	`+ * otherwise the behavior is undefined.`
`56`	`59`	`*/`
`57`	`60`	`void lp_ticker_wrapper_suspend(void);`
`58`	`61`