Skip to content

Commit 20239a5

Browse files
committed
update timer comment
1 parent c3082ff commit 20239a5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

components/timer/include/timer.hpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ class Timer : public BaseComponent {
122122
/// @brief Start the task watchdog for the timer.
123123
/// @return true if the watchdog was started, false otherwise.
124124
/// @note This function is only available on ESP
125-
/// @note This function is only available if CONFIG_ESP_TASK_WDT_EN is enabled
126-
/// in the menuconfig. Default is y (enabled).
125+
/// @note This function will do nothing unless CONFIG_ESP_TASK_WDT_EN is
126+
/// enabled in the menuconfig. Default is y (enabled).
127127
/// @see stop_watchdog()
128128
/// @see Task::start_watchdog()
129129
/// @see Task::stop_watchdog()
@@ -132,8 +132,8 @@ class Timer : public BaseComponent {
132132
/// @brief Stop the task watchdog for the timer.
133133
/// @return true if the watchdog was stopped, false otherwise.
134134
/// @note This function is only available on ESP
135-
/// @note This function is only available if CONFIG_ESP_TASK_WDT_EN is enabled
136-
/// in the menuconfig. Default is y (enabled).
135+
/// @note This function will do nothing unless CONFIG_ESP_TASK_WDT_EN is
136+
/// enabled in the menuconfig. Default is y (enabled).
137137
/// @see start_watchdog()
138138
/// @see Task::start_watchdog()
139139
/// @see Task::stop_watchdog()

0 commit comments

Comments
 (0)