Skip to content

Commit 1cfd366

Browse files
committed
Add minor comments to ao.h
1 parent abac3d3 commit 1cfd366

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

libs/ao/ao.h

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ bool am_ao_post_lifo_x(
264264
void am_ao_ctor(struct am_ao *ao, const struct am_hsm_state *state);
265265

266266
/**
267-
* Start an active object.
267+
* Start active object.
268268
*
269269
* The safest is to start active objects in the order of their priority,
270270
* beginning from the lowest priority active objects because they tend
@@ -295,7 +295,7 @@ void am_ao_start(
295295
);
296296

297297
/**
298-
* Stop an active object.
298+
* Stop active object.
299299
*
300300
* @param ao the active object to stop
301301
*/
@@ -373,6 +373,8 @@ bool am_ao_run_all(void);
373373
/**
374374
* Check if active object event queue is empty.
375375
*
376+
* Used for debugging.
377+
*
376378
* @param ao check the event queue of this active object
377379
*
378380
* @retval true the queue is empty
@@ -383,6 +385,8 @@ bool am_ao_event_queue_is_empty(struct am_ao *ao);
383385
/**
384386
* Log the content of the first num events in each event queue of every AO.
385387
*
388+
* Used for debugging.
389+
*
386390
* @param num the number of events to log. Use -1 to log all events.
387391
* @param log the logging callback
388392
*/
@@ -396,6 +400,8 @@ void am_ao_dump_event_queues(
396400
/**
397401
* Log last event of every active object.
398402
*
403+
* Used for debugging.
404+
*
399405
* @param log the logging callback
400406
*/
401407
void am_ao_log_last_events(void (*log)(const char *name, int event));

0 commit comments

Comments
 (0)