Better struct comment

2024-03-28 15:58:15 +08:00
parent 16d1ad30a7
commit 8d72288675
15 changed files with 154 additions and 131 deletions
@@ -29,15 +29,16 @@
 #include <stddef.h>

 /**
- * @struct CircularQueueInst
+ * @struct CIRC_QUEUE
+ * @brief Circular queue Instance
 */
 typedef struct
 {
    void **data;
-    volatile uint32_t nelts; /**< # elements */
-    uint32_t in;             /**< next empty location */
-    uint32_t out;            /**< next filled location */
-    uint32_t bounds;         /**< max size of queue */
+    volatile uint32_t nelts; ///< number of elements
+    uint32_t in;             ///< next empty location
+    uint32_t out;            ///< next filled location
+    uint32_t bounds;         ///< max size of queue
 } CIRC_QUEUE;

 /**