Fix orphographical errors in comments

Author: adel-mamin

apps/examples/async/main.c

@@ -48,7 +48,7 @@
  * async_top handles user input. Press ENTER to switch between
  * async_regular and async_off substates.
  *
- * Generally the use of async is warranted if the sequence of
+ * Generally the use of async is warranted, if the sequence of
  * steps can be represented as a flowchart like in this case.
  *
  * async_regular calls async_regular_() to do the printing

libs/ao/README.rst

@@ -116,5 +116,5 @@ Limitations
 
 - The maximum number of active objects (``AM_AO_NUM_MAX``) is constrained to 64
   by design for simplicity and resource efficiency.
-- Pub/sub functionality requires explicit initialization if used.
+- Pub/sub functionality requires explicit initialization, if used.
 

libs/ao/ao.c

@@ -68,7 +68,7 @@ bool am_ao_publish_exclude_x(
 
     if (!am_event_is_static(event)) {
         /*
-         * To avoid a potential race condition if higher priority
+         * To avoid a potential race condition, if higher priority
          * active object preempts the event publishing and frees the event
          * as processed.
          */

libs/ao/ao.h

@@ -184,7 +184,7 @@ bool am_ao_publish_exclude_x(
  * Publish \p event to all subscribed active objects except the given one.
  *
  * Same as am_ao_publish_exclude_x() except this function
- * crashes with assert if it fails delivering the \p event to at
+ * crashes with assert, if it fails delivering the \p event to at
  * least one subscribed active object.
  *
  * @param event  the event to publish
@@ -248,7 +248,7 @@ bool am_ao_publish_x(const struct am_event *event, int margin);
  * Publish \p event to all subscribed active objects.
  *
  * Same as am_ao_publish_x() except this function
- * crashes with assert if it fails delivering the \p event to at
+ * crashes with assert, if it fails delivering the \p event to at
  * least one subscribed active object.
  *
  * @param event  the event to publish
@@ -291,7 +291,8 @@ bool am_ao_post_fifo_x(
  * Post \p event to the back of active object's event queue.
  *
  * Same as am_ao_post_fifo_x() except this function
- * crashes with assert if it fails delivering the \p event to the active object.
+ * crashes with assert, if it fails delivering the \p event to the active
+ * object.
  *
  * @param ao     the event is posted to this active object
  * @param event  the event to post
@@ -331,7 +332,8 @@ bool am_ao_post_lifo_x(
  * Post \p event to the front of active object's event queue.
  *
  * Same as am_ao_post_lifo_x() except this function
- * crashes with assert if it fails delivering the \p event to the active object.
+ * crashes with assert, if it fails delivering the \p event to the active
+ * object.
  *
  * @param ao     the event is posted to this active object
  * @param event  the event to post
@@ -438,7 +440,7 @@ void am_ao_unsubscribe_all(const struct am_ao *ao);
 /**
  * Initialize active object global subscribe list.
  *
- * Optional. Only needed if active object pub/sub functionality is used.
+ * Optional. Only needed, if active object pub/sub functionality is used.
  * The pub/sub functionality is provided by
  * am_ao_publish(), am_ao_publish_x(),
  * am_ao_publish_exclude(), am_ao_publish_exclude_x(),

libs/ao/state.h

@@ -49,7 +49,7 @@ struct am_ao_state {
     struct am_ao_subscribe_list *sub;
     /** User defined pubsub list length. */
     int nsub;
-    /** User defined active objects, or NULL if not defined. */
+    /** User defined active objects, or NULL, if not defined. */
     struct am_ao *aos[AM_AO_NUM_MAX];
     /** Number of runnings AOs */
     int aos_cnt;

libs/async/async.h

@@ -94,7 +94,7 @@ struct am_async {
  * Await a condition before proceeding.
  *
  * Checks the provided condition `cond`.
- * Returns if the condition is not met (false) and
+ * Returns, if the condition is not met (false) and
  * on next invocation of the function the condition is evaluated again.
  *
  * Continues the function execution once the `cond` evaluates to `true`.

libs/common/compiler.h

@@ -579,7 +579,7 @@ AM_ASSERT_STATIC(LONG_MAX == ((1ULL << (unsigned)(LONG_BITS - 1)) - 1));
     })
 #endif /*AM_COMPILER_ID*/
 
-/** Add integers and assert if it overflows */
+/** Add integers and assert, if it overflows */
 #define AM_ADD_INT(a, b)                             \
     AM_EXTENSION({                                   \
         int add_res_;                                \
@@ -589,7 +589,7 @@ AM_ASSERT_STATIC(LONG_MAX == ((1ULL << (unsigned)(LONG_BITS - 1)) - 1));
         add_res_;                                    \
     })
 
-/** Multiply integers and assert if it overflows */
+/** Multiply integers and assert, if it overflows */
 #define AM_MUL_INT(a, b)                             \
     AM_EXTENSION({                                   \
         int mul_res_;                                \

libs/common/macros.h

@@ -46,7 +46,7 @@
  *    with an item that overloads operator[]().
  *    The compiler will complain instead of giving a bad result.
  * 2. if a pointer is mistakenly passed as the argument, the compiler will
- *    complain in some cases - specifically if the pointer's size isn't evenly
+ *    complain in some cases - specifically, if the pointer's size isn't evenly
  *    divisible by the size of the object the pointer points to.
  *    In that situation a divide-by-zero will cause the compiler to error out.
  */

libs/crc/crc.h

@@ -54,7 +54,7 @@ extern "C" {
  * for details.
  *
  * @param data  data for which the checksum is to be calculated
- *              NULL is a valid value if size is zero.
+ *              NULL is a valid value, if size is zero.
  * @param size  data size [bytes]
  * @param crc   initial CRC value
  *              Must be 0xFFFF at start or the result of previous crc16() call,
@@ -82,7 +82,7 @@ unsigned int crc16(const unsigned char *data, int size, unsigned int crc);
  * for details.
  *
  * @param data  data for which the checksum is to be calculated
- *              NULL is a valid value if size is zero.
+ *              NULL is a valid value, if size is zero.
  * @param size  data array size [bytes]
  * @param crc   initial CRC value
  *              Must be 0x000000 at start or the result of previous crc24()
@@ -110,8 +110,8 @@ unsigned long crc24(const unsigned char *data, int size, unsigned long crc);
  * http://reveng.sourceforge.net/crc-catalogue/17plus.htm (CRC-32/MPEG-2)
  * for details.
  *
- * @param data  data for which the checksum is to be calculated
- *              NULL is a valid value if size is zero
+ * @param data  data for which the checksum is to be calculated.
+ *              NULL is a valid value, if size is zero.
  * @param size  data array size [bytes]
  * @param crc   initial CRC value
  *              Must be 0xFFFFFFFF at start or the result of previous crc32()

libs/dlist/dlist.h

@@ -132,7 +132,7 @@ void am_dlist_item_ctor(struct am_dlist_item *item);
  * @param list  the list
  * @param item  the item next to this one is returned
  *
- * @return the next item or NULL if \a item is the last one in the list
+ * @return the next item or NULL, if \a item is the last one in the list
  */
 struct am_dlist_item *am_dlist_next(
     const struct am_dlist *list, const struct am_dlist_item *item
@@ -147,7 +147,7 @@ struct am_dlist_item *am_dlist_next(
  * @param list  the list
  * @param item  the item previous to this one is returned
  *
- * @return the previous item or NULL if \a item is the first one in the list
+ * @return the previous item or NULL, if \a item is the first one in the list
  */
 struct am_dlist_item *am_dlist_prev(
     const struct am_dlist *list, const struct am_dlist_item *item
@@ -204,7 +204,7 @@ void am_dlist_pop(struct am_dlist_item *item);
  *
  * @param list  the list
  *
- * @return the popped item or NULL if the list was empty
+ * @return the popped item or NULL, if the list was empty
  */
 struct am_dlist_item *am_dlist_pop_front(struct am_dlist *list);
 
@@ -213,7 +213,7 @@ struct am_dlist_item *am_dlist_pop_front(struct am_dlist *list);
  *
  * @param list  the list
  *
- * @return the popped item or NULL if the list was empty
+ * @return the popped item or NULL, if the list was empty
  */
 struct am_dlist_item *am_dlist_pop_back(struct am_dlist *list);
 
@@ -224,7 +224,7 @@ struct am_dlist_item *am_dlist_pop_back(struct am_dlist *list);
  *
  * @param list  the list
  *
- * @return The pointer to the front (head) item or NULL if the list is empty
+ * @return The pointer to the front (head) item or NULL, if the list is empty
  */
 struct am_dlist_item *am_dlist_peek_front(struct am_dlist *list);
 
@@ -235,7 +235,7 @@ struct am_dlist_item *am_dlist_peek_front(struct am_dlist *list);
  *
  * @param list  the list
  *
- * @return the pointer to the back (tail) item or NULL if the list is empty
+ * @return the pointer to the back (tail) item or NULL, if the list is empty
  */
 struct am_dlist_item *am_dlist_peek_back(struct am_dlist *list);
 
@@ -300,7 +300,7 @@ void am_dlist_iterator_ctor(
  *
  * @param it  the iterator constructed by am_dlist_iterator_ctor()
  *
- * @return the visited item or NULL if the iteration is over
+ * @return the visited item or NULL, if the iteration is over
  *         The item is not popped from the list.
  */
 struct am_dlist_item *am_dlist_iterator_next(struct am_dlist_iterator *it);