Skip to content

Commit

Permalink
doc: drivers: system timer: unique documentation header
Browse files Browse the repository at this point in the history
Without enough context, the "clock" term is underspecified in Zephyr.
This change renames "Clock API" to "System Clock API" as both the
functions as well as the remaining documentation calls the clock being
documented here this way.

This tries to ensure that people landing on this API from context free
search will be less confused.

Signed-off-by: Florian Grandel <[email protected]>
  • Loading branch information
fgrandel authored and carlescufi committed Jun 30, 2023
1 parent 5fa5534 commit 03b4942
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions include/zephyr/drivers/timer/system_timer.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ extern "C" {
#endif

/**
* @brief Clock APIs
* @defgroup clock_apis Clock APIs
* @brief System Clock APIs
* @defgroup clock_apis System Clock APIs
* @{
*/

Expand Down

0 comments on commit 03b4942

Please sign in to comment.