Get rid of CONF_LEAF and CONF_HUB, and follow up with code cleanups.

[ircu2.10.12-pk.git] / include / list.h

diff --git a/include/list.h b/include/list.h
index 447a837e25e3ed457ae550c89dce850cb2e9e21f..a400ee29c8e1e30abaa777ccb557b40f50353e33 100644 (file)
--- a/include/list.h
+++ b/include/list.h
@@ -1,7 +1,6 @@
-/*
- * list.h
- *
- * $Id$
+/** @file list.h
+ * @brief Singly and doubly linked list manipulation interface.
+ * @version $Id$
  */
 #ifndef INCLUDED_list_h
 #define INCLUDED_list_h
@@ -23,28 +22,28 @@ struct ConfItem;
 struct SLink {
   struct SLink *next; /**< Next element in list. */
   union {
-    struct Client *cptr;
-    struct Channel *chptr;
-    struct ConfItem *aconf;
-    char *cp;
+    struct Client *cptr;    /**< List element as a client. */
+    struct Channel *chptr;  /**< List element as a channel. */
+    struct ConfItem *aconf; /**< List element as a configuration item. */
+    char *cp;               /**< List element as a string. */
     struct {
-      char *banstr;
-      char *who;
-      time_t when;
-    } ban;
-  } value; /**< Value of list element. */
-  unsigned int flags; /**< Modifier flags for list element. */
+      char *banstr;         /**< Ban hostmask. */
+      char *who;            /**< Name of client that set the ban. */
+      time_t when;          /**< Timestamp when ban was added. */
+    } ban;                  /**< List element as a ban. */
+  } value;                  /**< Value of list element. */
+  unsigned int flags;       /**< Modifier flags for list element. */
 };
 
 /** Node in a doubly linked list. */
 struct DLink {
-  struct DLink*  next; /**< Next element in list. */
-  struct DLink*  prev; /**< Previous element in list. */
+  struct DLink*  next;      /**< Next element in list. */
+  struct DLink*  prev;      /**< Previous element in list. */
   union {
-    struct Client*  cptr;
-    struct Channel* chptr;
-    char*           ch;
-  } value; /**< Value of list element. */
+    struct Client*  cptr;   /**< List element as a client. */
+    struct Channel* chptr;  /**< List element as a channel. */
+    char*           ch;     /**< List element as a string. */
+  } value;                  /**< Value of list element. */
 };
 
 /*
@@ -63,7 +62,7 @@ extern void remove_client_from_list(struct Client *cptr);
 extern void add_client_to_list(struct Client *cptr);
 extern struct DLink *add_dlink(struct DLink **lpp, struct Client *cp);
 extern void remove_dlink(struct DLink **lpp, struct DLink *lp);
-extern struct ConfItem *make_conf(void);
+extern struct ConfItem *make_conf(int type);
 extern void free_conf(struct ConfItem *aconf);
 extern void send_listinfo(struct Client *cptr, char *name);