Doxyfy list.h, removing the unused delist_conf() function.
authorMichael Poole <mdpoole@troilus.org>
Tue, 21 Sep 2004 22:52:20 +0000 (22:52 +0000)
committerMichael Poole <mdpoole@troilus.org>
Tue, 21 Sep 2004 22:52:20 +0000 (22:52 +0000)
git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1165 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

include/list.h

index afe43226d3bdbbfa986f645695ca868e9bb3dd8f..447a837e25e3ed457ae550c89dce850cb2e9e21f 100644 (file)
@@ -15,12 +15,13 @@ struct Connection;
 struct Channel;
 struct ConfItem;
 
-/* 
+/*
  * Structures
  */
 
+/** Node in a singly linked list. */
 struct SLink {
-  struct SLink *next;
+  struct SLink *next; /**< Next element in list. */
   union {
     struct Client *cptr;
     struct Channel *chptr;
@@ -31,18 +32,19 @@ struct SLink {
       char *who;
       time_t when;
     } ban;
-  } value;
-  unsigned int flags;
+  } value; /**< Value of list element. */
+  unsigned int flags; /**< Modifier flags for list element. */
 };
 
+/** Node in a doubly linked list. */
 struct DLink {
-  struct DLink*  next;
-  struct DLink*  prev;
+  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; /**< Value of list element. */
 };
 
 /*
@@ -62,7 +64,6 @@ 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 void delist_conf(struct ConfItem *aconf);
 extern void free_conf(struct ConfItem *aconf);
 extern void send_listinfo(struct Client *cptr, char *name);