Better struct comment

df_datalink_sp/src/include/clist.h

@@ -32,104 +32,100 @@ extern "C"
 #include <stdlib.h>
 #include <stdint.h>
 
-    /**
-     * @enum cListDirection
-     * @brief clist_t iterator direction.
-     */
+	/**
+	 * @enum clist_direction_t
+	 * @brief clist_t iterator direction.
+	 */
+	typedef enum
+	{
+		LIST_HEAD,
+		LIST_TAIL
+	} clist_direction_t;
 
-    typedef enum
-    {
-        LIST_HEAD,
-        LIST_TAIL
-    } clist_direction_t;
+	/**
+	 * @struct clist_node_t
+	 * @brief clist_t node struct.
+	 */
+	typedef struct
+	{
+		struct clist_node *prev; ///< previous node
+		struct clist_node *next; ///< next node
+		void *val;
+	} clist_node_t;
 
-    /**
-     * @struct cListNode
-     * @brief clist_t node struct.
-     */
+	/**
+	 * @struct clist_t
+	 * @brief clist_t struct.
+	 */
+	typedef struct
+	{
+		clist_node_t *head;					 ///< first node
+		clist_node_t *tail;					 ///< last node
+		uint32_t len;						 ///< list length
+		void (*free)(void *val);			 ///< node free function handle
+		int8_t (*compare)(void *a, void *b); ///< node compare function handle
+	} clist_t;
 
-    typedef struct clist_node
-    {
-        struct clist_node *prev;
-        struct clist_node *next;
-        void *val;
-    } clist_node_t;
+	/**
+	 * @struct clist_iterator_t
+	 * @brief clist_t iterator struct.
+	 */
+	typedef struct
+	{
+		clist_node_t *next;			 ///< next element
+		clist_direction_t direction; ///< iter direction
+	} clist_iterator_t;
 
-    /**
-     * @struct cListInst
-     * @brief clist_t struct.
-     */
+	// Node prototypes.
 
-    typedef struct
-    {
-        clist_node_t *head;
-        clist_node_t *tail;
-        uint32_t len;
-        void (*free)(void *val);
-        int8_t (*compare)(void *a, void *b);
-    } clist_t;
+	clist_node_t *
+	clist_node_new(void *val);
 
-    /**
-     * @struct cListIter
-     * @brief clist_t iterator struct.
-     */
+	// clist_t prototypes.
 
-    typedef struct
-    {
-        clist_node_t *next;
-        clist_direction_t direction;
-    } clist_iterator_t;
+	clist_t *
+	clist_new(void);
 
-    // Node prototypes.
+	clist_node_t *
+	clist_rpush(clist_t *self, clist_node_t *node);
 
-    clist_node_t *
-    clist_node_new(void *val);
+	clist_node_t *
+	clist_lpush(clist_t *self, clist_node_t *node);
 
-    // clist_t prototypes.
+	clist_node_t *
+	clist_find(clist_t *self, void *val);
 
-    clist_t *
-    clist_new(void);
+	clist_node_t *
+	clist_at(clist_t *self, int index);
 
-    clist_node_t *
-    clist_rpush(clist_t *self, clist_node_t *node);
+	clist_node_t *
+	clist_rpop(clist_t *self);
 
-    clist_node_t *
-    clist_lpush(clist_t *self, clist_node_t *node);
+	clist_node_t *
+	clist_lpop(clist_t *self);
 
-    clist_node_t *
-    clist_find(clist_t *self, void *val);
+	void
+	clist_remove(clist_t *self, clist_node_t *node);
 
-    clist_node_t *
-    clist_at(clist_t *self, int index);
+	void
+	clist_clear(clist_t *self);
 
-    clist_node_t *
-    clist_rpop(clist_t *self);
+	void
+	clist_destroy(clist_t *self);
 
-    clist_node_t *
-    clist_lpop(clist_t *self);
+	// clist_t iterator prototypes.
 
-    void
-    clist_remove(clist_t *self, clist_node_t *node);
+	clist_iterator_t *
+	clist_iterator_new(clist_t *list, clist_direction_t direction);
 
-    void
-    clist_clear(clist_t *self);
+	clist_iterator_t *
+	clist_iterator_new_from_node(clist_node_t *node, clist_direction_t direction);
 
-    void
-    clist_destroy(clist_t *self);
+	clist_node_t *
+	clist_iterator_next(clist_iterator_t *self);
 
-    // clist_t iterator prototypes.
-
-    clist_iterator_t *
-    clist_iterator_new(clist_t *list, clist_direction_t direction);
-
-    clist_iterator_t *
-    clist_iterator_new_from_node(clist_node_t *node, clist_direction_t direction);
-
-    clist_node_t *
-    clist_iterator_next(clist_iterator_t *self);
-
-    void
-    clist_iterator_destroy(clist_iterator_t *self);
+	void
+	clist_iterator_destroy(clist_iterator_t *self);
 
 #ifdef __cplusplus
 }