Skip to content

Commit 80a0b20

Browse files
Mel Wrajkan01
authored andcommitted
Capitalizing Watchdog
1 parent 3725af3 commit 80a0b20

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

TESTS/mbed_hal/watchdog/watchdog_api_tests.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,43 +27,43 @@
2727

2828
/** Test max_timeout validity
2929
*
30-
* Given a device supporting watchdog HAL API,
30+
* Given a device supporting Watchdog HAL API,
3131
* when @a hal_watchdog_get_platform_features() is called,
3232
* then max_timeout member of returned watchdog_features_t struct is greater than 1.
3333
*/
3434
void test_max_timeout_is_valid();
3535

36-
/** Test watchdog features if a stopped watchdog can be started again
36+
/** Test Watchdog features if a stopped Watchdog can be started again
3737
*
38-
* Given a device supporting watchdog HAL API,
38+
* Given a device supporting Watchdog HAL API,
3939
* when the device supports the @a disable_watchdog feature,
4040
* then the device also supports @a update_config feature.
4141
*/
4242
void test_restart_is_possible();
4343

44-
/** Test watchdog stop
44+
/** Test Watchdog stop
4545
*
4646
* Given a device without a support for the @a disable_watchdog feature,
4747
* when @a hal_watchdog_stop() is called,
4848
* then WATCHDOG_STATUS_NOT_SUPPORTED is returned.
4949
*
5050
* Otherwise, given the device with @a disable_watchdog feature support:
5151
*
52-
* Given the watchdog is *NOT* running,
52+
* Given the Watchdog is *NOT* running,
5353
* when @a hal_watchdog_stop() is called,
5454
* then WATCHDOG_STATUS_OK is returned.
5555
*
56-
* Given the watchdog is running,
56+
* Given the Watchdog is running,
5757
* when @a hal_watchdog_stop() is called before the timeout expires,
5858
* then WATCHDOG_STATUS_OK is returned and the device is not restarted.
5959
*
60-
* Given the watchdog is *NOT* running (it has already been stopped),
60+
* Given the Watchdog is *NOT* running (it has already been stopped),
6161
* when @a hal_watchdog_stop() is called,
6262
* then WATCHDOG_STATUS_OK is returned.
6363
*/
6464
void test_stop();
6565

66-
/** Test watchdog init multiple times
66+
/** Test Watchdog init multiple times
6767
*
6868
* Given @a max_timeout value returned by @a hal_watchdog_get_platform_features():
6969
*
@@ -84,18 +84,18 @@ void test_stop();
8484
*/
8585
void test_update_config();
8686

87-
/** Test watchdog init with a valid config
87+
/** Test Watchdog init with a valid config
8888
*
8989
* Given @a config.timeout_ms is set to X ms,
90-
* which is within supported watchdog timeout range,
90+
* which is within supported Watchdog timeout range,
9191
* when @a hal_watchdog_init() is called,
9292
* then @a WATCHDOG_STATUS_OK is returned
9393
* and @a hal_watchdog_get_reload_value() returns X.
9494
*/
9595
template<uint32_t timeout_ms>
9696
void test_init();
9797

98-
/** Test watchdog init with a max_timeout
98+
/** Test Watchdog init with a max_timeout
9999
*
100100
* Given @a config.timeout_ms is set to max_timeout,
101101
* which is a value returned by @a hal_watchdog_get_platform_features(),

0 commit comments

Comments
 (0)