Add clarification to rtc_free doxygen

bulislaw · bulislaw · commit 93a7db5d8439 · 2018-05-25T12:49:11.000-05:00
diff --git a/hal/rtc_api.h b/hal/rtc_api.h
@@ -96,7 +96,8 @@ void rtc_init(void);
 
 /** Deinitialize RTC
  *
- * Powerdown the RTC in preparation for sleep, powerdown or reset.
+ * Powerdown the RTC in preparation for sleep, powerdown or reset. That should only
+ * affect the CPU domain and not the time keeping logic.
  * After this function is called no other RTC functions should be called
  * except for ::rtc_init.
  *

Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,8 @@ void rtc_init(void);`
`96`	`96`
`97`	`97`	`/** Deinitialize RTC`
`98`	`98`	`*`
`99`		`- * Powerdown the RTC in preparation for sleep, powerdown or reset.`
	`99`	`+ * Powerdown the RTC in preparation for sleep, powerdown or reset. That should only`
	`100`	`+ * affect the CPU domain and not the time keeping logic.`
`100`	`101`	`* After this function is called no other RTC functions should be called`
`101`	`102`	`* except for ::rtc_init.`
`102`	`103`	`*`