Correct powman_timer_enable_alarm_at_ms documentation note

jdomnitz · jdomnitz · commit 3359eb3ca868 · 2025-11-11T12:35:56.000-05:00
diff --git a/src/rp2_common/hardware_powman/include/hardware/powman.h b/src/rp2_common/hardware_powman/include/hardware/powman.h
@@ -84,7 +84,7 @@ void powman_timer_set_ms(uint64_t time_ms);
 /*! \brief Set an alarm at an absolute time in ms
  *  \ingroup hardware_powman
  *
- * Note, the timer is stopped and then restarted as part of this function. This only controls the alarm
+ * Note, the alarm is stopped and then restarted as part of this function. This only controls the alarm
  * if you want to use the alarm to wake up powman then you should use \ref powman_enable_alarm_wakeup_at_ms
  *
  * \param alarm_time_ms time at which the alarm will fire

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ void powman_timer_set_ms(uint64_t time_ms);`
`84`	`84`	`/*! \brief Set an alarm at an absolute time in ms`
`85`	`85`	`* \ingroup hardware_powman`
`86`	`86`	`*`
`87`		`- * Note, the timer is stopped and then restarted as part of this function. This only controls the alarm`
	`87`	`+ * Note, the alarm is stopped and then restarted as part of this function. This only controls the alarm`
`88`	`88`	`* if you want to use the alarm to wake up powman then you should use \ref powman_enable_alarm_wakeup_at_ms`
`89`	`89`	`*`
`90`	`90`	`* \param alarm_time_ms time at which the alarm will fire`