Skip to content

Commit eb9ea50

Browse files
committed
Update documentation in libs/event/event.h libs/timer/README.rst
1 parent 3b555a0 commit eb9ea50

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

libs/event/event.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ enum am_event_rc {
9494
AM_EVENT_RC_OK = 0, /**< success */
9595
/**
9696
* Success.
97-
* Also tells that event queue was empty before the call.
97+
* Also tells that event queue was empty before the corresponding call.
9898
* This allows to signal the event queue owner about
9999
* new event available for processing.
100100
*/
@@ -129,13 +129,13 @@ extern "C" {
129129
#endif
130130

131131
/**
132-
* Event state constructor.
132+
* Event library state constructor.
133133
*
134-
* Must be called before calling any other event APIs.
134+
* Must be called before calling any other event library APIs.
135135
*
136136
* Not thread safe.
137137
*
138-
* @param cfg event state configuration.
138+
* @param cfg event library state configuration.
139139
* The event library makes an internal copy of the configuration.
140140
*/
141141
void am_event_state_ctor(const struct am_event_state_cfg *cfg);
@@ -260,7 +260,7 @@ void am_event_free(const struct am_event **event);
260260
/**
261261
* Duplicate an event (eXtended version).
262262
*
263-
* Allocates it from memory pools provided with am_event_add_pool() function.
263+
* Allocates it from memory pools provided by am_event_add_pool() function.
264264
*
265265
* Checks if there are more free memory blocks available than \p margin.
266266
* If not, then returns NULL. Otherwise allocates memory block
@@ -281,7 +281,7 @@ struct am_event *am_event_dup_x(
281281
/**
282282
* Duplicate an event.
283283
*
284-
* Allocates it from memory pools provided with am_event_add_pool() function.
284+
* Allocates it from memory pools provided by am_event_add_pool() function.
285285
*
286286
* The function asserts if there is no memory left to allocated the event.
287287
*

libs/timer/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Key Features
2222

2323
2. **Tick-Based Operation**:
2424

25-
- Timers operate on a tick-based system, updated with ``am_timer_tick``.
25+
- Timers operate on a tick-based system, updated with :cpp:func:`am_timer_tick`.
2626
- Multiple tick domains are supported for independent timer operation.
2727

2828
3. **Thread Safety**:

0 commit comments

Comments
 (0)