Improve API documentation

Author: adel-mamin

docs/api.rst

@@ -25,6 +25,10 @@ Common Types
 Singly Linked List
 ------------------
 
+Singly linked list API documentation.
+
+The source code of the corresponding header file is in `slist.h <https://github.com/adel-mamin/amast/blob/main/libs/slist/slist.h>`_.
+
 .. doxygenstruct:: am_slist_item
 
 .. doxygenstruct:: am_slist
@@ -74,6 +78,10 @@ Singly Linked List
 Bit
 ---
 
+Bit API documentation.
+
+The source code of the corresponding header file is in `bit.h <https://github.com/adel-mamin/amast/blob/main/libs/bit/bit.h>`_.
+
 .. doxygenstruct:: am_bit_u64
 
 .. doxygenfunction:: am_bit_u64_is_empty
@@ -91,6 +99,10 @@ Bit
 Ring Buffer
 -----------
 
+Ring buffer API documentation.
+
+The source code of the corresponding header file is in `ringbuf.h <https://github.com/adel-mamin/amast/blob/main/libs/ringbuf/ringbuf.h>`_.
+
 .. doxygenstruct:: am_ringbuf
 
 .. doxygenfunction:: am_ringbuf_ctor
@@ -118,6 +130,10 @@ Ring Buffer
 Queue
 -----
 
+Queue API documentation.
+
+The source code of the corresponding header file is in `queue.h <https://github.com/adel-mamin/amast/blob/main/libs/bit/bit.h>`_.
+
 .. doxygenstruct:: am_queue
 
 .. doxygenfunction:: am_queue_ctor
@@ -155,6 +171,10 @@ Queue
 Onesize
 -------
 
+Onesize memory allocator API documentation.
+
+The source code of the corresponding header file is in `onesize.h <https://github.com/adel-mamin/amast/blob/main/libs/async/onesize.h>`_.
+
 .. doxygenstruct:: am_onesize
 
 .. doxygenstruct:: am_onesize_cfg
@@ -187,6 +207,10 @@ Onesize
 Event
 -----
 
+Event API documentation.
+
+The source code of the corresponding header file is in `event.h <https://github.com/adel-mamin/amast/blob/main/libs/async/event.h>`_.
+
 .. doxygendefine:: AM_EVT_USER
 
 .. doxygendefine:: AM_EVENT_POOLS_NUM_MAX
@@ -259,6 +283,10 @@ Event
 Timer
 -----
 
+Async API documentation.
+
+The source code of the corresponding header file is in `timer.h <https://github.com/adel-mamin/amast/blob/main/libs/timer/timer.h>`_.
+
 .. doxygentypedef:: am_timer_post_fn
 
 .. doxygentypedef:: am_timer_publish_fn
@@ -295,6 +323,10 @@ Timer
 Async
 -----
 
+Async API documentation.
+
+The source code of the corresponding header file is in `async.h <https://github.com/adel-mamin/amast/blob/main/libs/async/async.h>`_.
+
 .. doxygendefine:: AM_ASYNC_STATE_INIT
 
 .. doxygenenum:: am_async_rc
@@ -375,6 +407,10 @@ The source code of the corresponding header file is in `hsm.h <https://github.co
 FSM
 ---
 
+Finite State Machine (FSM) API documentation.
+
+The source code of the corresponding header file is in `fsm.h <https://github.com/adel-mamin/amast/blob/main/libs/fsm/fsm.h>`_.
+
 .. doxygenenum:: am_fsm_evt_id
 
 .. doxygenenum:: am_fsm_rc
@@ -412,6 +448,10 @@ FSM
 AO
 --
 
+Active Object (AO API documentation.
+
+The source code of the corresponding header file is in `ao.h <https://github.com/adel-mamin/amast/blob/main/libs/ao/ao.h>`_.
+
 .. doxygenstruct:: am_ao
 
 .. doxygenstruct:: am_ao_state_cfg
@@ -480,6 +520,10 @@ AO
 PAL
 ---
 
+Platform Abstraction Layer (PAL) API documentation.
+
+The source code of the corresponding header file is in `pal.h <https://github.com/adel-mamin/amast/blob/main/libs/pal/pal.h>`_.
+
 .. doxygendefine:: AM_PAL_TASK_NUM_MAX
 
 .. doxygendefine:: AM_PAL_TASK_ID_NONE

libs/async/async.h

@@ -118,7 +118,7 @@ struct am_async {
  *
  * Checks the provided condition `cond`.
  * If the condition is not met (false) - returns #AM_ASYNC_RC_BUSY
- * and on next invocation of the function the condition is avaluated again.
+ * and on next invocation of the function the condition is evaluated again.
  *
  * Continues the function execution once the `cond` evaluates to `true`.
  *

pixi.toml

@@ -1,7 +1,7 @@
 [project]
 authors = ["Adel Mamin <[email protected]>"]
 channels = ["conda-forge"]
-description = "Add a short description here"
+description = "A Minimalist Asynchronous Toolkit"
 name = "amast"
 platforms = ["linux-64"]
 version = "0.1.0"