Fix typos

Author: adel-mamin

CHANGELOG.md

@@ -30,7 +30,7 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 - Rename `am_event_log_pools_unsafe()` to `am_event_pool_log_unsafe()`.
 - Rename `am_event_push_back...()` to `am_event_queue_push_back...()`
 - Rename `am_event_push_front...()` to `am_event_queue_push_front...()`
-- Change return valus of `am_event_queue_pop_front_with_cb()` to `enum am_rc`
+- Change return values of `am_event_queue_pop_front_with_cb()` to `enum am_rc`
 
 ### Added
 

libs/event/README.rst

@@ -123,22 +123,22 @@ Event Ownership Diagram
   |              |------------------------------->|   event owned by    |
   |              |                                |   application       |
   |              |  am_event_free(event)          |   with read and     |
-  |              |  am_event_push_...(event)      |   write permissions |
+  |              |  am_event_queue_push_...(event)|   write permissions |
   |              |  am_ao_publish_...(event)      |                     |
   |              |  am_ao_post_...(event)         |                     |
   |              |<-------------------------------|                     |
   |              |                                +---------------------+
   |              |                                           |
   |              |                                           |
-  |              |                            am_event_inc_ref_cnt(event) and
-  |              |                            am_event_push_...(event) and/or
-  |              |                            am_ao_publish_...(event) and/or
-  | event owned  |                            am_ao_post_...(event)
+  |              |                         am_event_inc_ref_cnt(event) and
+  |              |                         am_event_queue_push_...(event) and/or
+  |              |                         am_ao_publish_...(event) and/or
+  | event owned  |                         am_ao_post_...(event)
   | by event lib |                                           |
   |              |                                           v
   |              |  am_hsm_dispatch(event)        +---------------------+
   |              |  am_fsm_dispatch(event)        |                     |
-  |              |  am_event_pop_front()          |                     |
+  |              |  am_event_queue_pop_front()    |                     |
   |              |------------------------------->|                     |
   |              |                                |   event owned by    |
   |              |  return from                   |   application       |
@@ -152,9 +152,9 @@ Event Ownership Diagram
   |              |                                    |              ^
   |              |                                    |              |
   |              |                                    +--------------+
-  |              |                                 am_event_push_...(event)
-  |              |                                 am_ao_publish_...(event)
-  +--------------+                                 am_ao_post_...(event)
+  |              |                               am_event_queue_push_...(event)
+  |              |                               am_ao_publish_...(event)
+  +--------------+                               am_ao_post_...(event)
 
 
 Please note that the following pseudocode shows an incorrect use of the API:

libs/event/event.c

@@ -500,7 +500,7 @@ typedef bool (*am_push_fn)(
     struct am_event_queue *queue, const struct am_event *event
 );
 
-static enum am_rc am_event_push_x(
+static enum am_rc event_queue_push_x(
     struct am_event_queue *queue,
     const struct am_event *event,
     int margin,
@@ -564,7 +564,7 @@ static enum am_rc am_event_push_x(
 enum am_rc am_event_queue_push_back_x(
     struct am_event_queue *queue, const struct am_event *event, int margin
 ) {
-    return am_event_push_x(
+    return event_queue_push_x(
         queue, event, margin, /*safe=*/true, event_queue_push_back
     );
 }
@@ -580,7 +580,7 @@ enum am_rc am_event_queue_push_back(
 enum am_rc am_event_queue_push_back_unsafe(
     struct am_event_queue *queue, const struct am_event *event
 ) {
-    enum am_rc rc = am_event_push_x(
+    enum am_rc rc = event_queue_push_x(
         queue, event, /*margin=*/0, /*safe=*/false, event_queue_push_back
     );
     AM_ASSERT(AM_RC_ERR != rc);
@@ -590,7 +590,7 @@ enum am_rc am_event_queue_push_back_unsafe(
 enum am_rc am_event_queue_push_front_x(
     struct am_event_queue *queue, const struct am_event *event, int margin
 ) {
-    return am_event_push_x(
+    return event_queue_push_x(
         queue, event, margin, /*safe=*/true, event_queue_push_front
     );
 }
@@ -626,7 +626,7 @@ enum am_rc am_event_queue_pop_front_with_cb(
      *  const struct am_event *e = am_event_allocate(id, size);
      *  am_event_inc_ref_cnt(e); <-- THIS IS MISSING
      *  am_hsm_dispatch(hsm, e);
-     *      am_event_push_XXX(...) & am_event_queue_pop_front_with_cb(...)
+     *      am_event_queue_push_XXX(...) & am_event_queue_pop_front_with_cb(...)
      *      OR
      *      am_event_inc_ref_cnt(e) & am_event_dec_ref_cnt(e)
      *  am_event_free(&e);

libs/fsm/fsm.c

@@ -116,7 +116,7 @@ void am_fsm_dispatch(struct am_fsm *fsm, const struct am_event *event) {
      *  const struct am_event *e = am_event_allocate(id, size);
      *  am_event_inc_ref_cnt(e); <-- THIS IS MISSING
      *  am_fsm_dispatch(fsm, e);
-     *      am_event_push_XXX(...) & am_event_queue_pop_front_with_cb(...)
+     *      am_event_queue_push_XXX(...) & am_event_queue_pop_front_with_cb(...)
      *      OR
      *      am_event_inc_ref_cnt(e) & am_event_dec_ref_cnt(e)
      *  am_event_free(&e);