Merge branch 'master' into dev-opt

[libucw.git] / ucw / simple-lists.h

diff --git a/ucw/simple-lists.h b/ucw/simple-lists.h
index e8bf62513218b7bf7bf3a303777d451c7db571eb..f816fb4ab2106ff8efca13705a3fd7bd92834825 100644 (file)
--- a/ucw/simple-lists.h
+++ b/ucw/simple-lists.h
@@ -10,8 +10,25 @@
 #ifndef _UCW_SIMPLE_LISTS_H
 #define _UCW_SIMPLE_LISTS_H
 
-#include "ucw/clists.h"
+#include <ucw/clists.h>
 
+#ifdef CONFIG_UCW_CLEAN_ABI
+#define cf_2string_list_config ucw_cf_2string_list_config
+#define cf_string_list_config ucw_cf_string_list_config
+#define simp2_append ucw_simp2_append
+#define simp_append ucw_simp_append
+#endif
+
+/***
+ * To simplify very common usage of circular linked links, whose nodes can hold only one or two trivial values,
+ * we define some generic node types, called the simple nodes.
+ *
+ * To avoid some type casts, values in simple nodes are defined as unions of most frequent types.
+ ***/
+
+/**
+ * Simple node with one value.
+ **/
 typedef struct simp_node {
   cnode n;
   union {
@@ -22,6 +39,9 @@ typedef struct simp_node {
   };
 } simp_node;
 
+/**
+ * Simple node with two values.
+ **/
 typedef struct simp2_node {
   cnode n;
   union {
@@ -39,11 +59,27 @@ typedef struct simp2_node {
 } simp2_node;
 
 struct mempool;
+
+/**
+ * Allocate a new one-value node on memory pool @mp and insert it to @l. The value is undefined and should be changed afterwards.
+ **/
 simp_node *simp_append(struct mempool *mp, clist *l);
+
+/**
+ * Allocate a new two-value node on memory pool @mp and insert it to @l. The values are undefined and should be changed afterwards.
+ **/
 simp2_node *simp2_append(struct mempool *mp, clist *l);
 
 /* Configuration sections */
+
+/**
+ * Default definition of the configuration section with one-value string node. Identifier of the value is `String`.
+ **/
 extern struct cf_section cf_string_list_config;
+
+/**
+ * Default definition of the configuration section with two-value string node. Identifiers of the values are `Src` and `Dest`.
+ **/
 extern struct cf_section cf_2string_list_config;
 
 #endif