Document reset reason enum

2018-03-15 10:56:47 +00:00 · 2018-03-15 10:56:47 +00:00 · f3c6c569d1
parent 239c8a3cad
commit f3c6c569d1
1 changed files with 2 additions and 0 deletions
--- a/hal/reset_reason_api.h
+++ b/hal/reset_reason_api.h
@ -31,6 +31,8 @@ extern "C" {
 * @{
 */

+/** Definitions of different reset reasons
+ */
 typedef enum {
  RESET_REASON_POWER_ON,       /**< Set when power is initially applied to the board. The power-on-reset circuit causes a POWER_ON reset when this occurs */
  RESET_REASON_PIN_RESET,      /**< Set when a reset is triggered by the hardware pin on the board */