Browse Source

faux: Some doxygen docs for list

Serj Kalichev 4 years ago
parent
commit
b38a62c099
2 changed files with 15 additions and 0 deletions
  1. 4 0
      faux/list.h
  2. 11 0
      faux/list/list.c

+ 4 - 0
faux/list.h

@@ -1,3 +1,7 @@
+/** @file list.h
+ * @brief Public interface for a bidirectional list.
+ */
+
 #ifndef _faux_list_h
 #define _faux_list_h
 

+ 11 - 0
faux/list/list.c

@@ -141,6 +141,12 @@ void *faux_list_each(faux_list_node_t **iter) {
 
 
 /** @brief Allocate and initialize bidirectional list.
+ *
+ * Prototypes for callback functions:
+ * @code
+ * int faux_list_compare_fn(const void *first, const void *second);
+ * void faux_list_free_fn(void *data);
+ * @endcode
  *
  * @param [in] compareFn Callback function to compare two user data instances
  * to sort list.
@@ -436,6 +442,11 @@ int faux_list_del(faux_list_t *list, faux_list_node_t *node) {
  * current iterator. So user can call to faux_list_match_node() for several
  * times and gets all matched nodes from list.
  *
+ * Prototype for matchFn callback function:
+ * @code
+ * int faux_list_match_fn(const void *key, const void *data);
+ * @endcode
+ *
  * @param [in] list List.
  * @param [in] matchFn User defined matching callback function.
  * @param [in] userkey User defined data to use in matchFn function.