Add Doxygen @file documentation to each source and header file

[ngircd-alex.git] / src / ngircd / lists.h

diff --git a/src/ngircd/lists.h b/src/ngircd/lists.h
index f9b3ff2feaa09f8d9b091ca405caa1d933a8bc86..c39325ea0ea869bf646e5495eeb812fe6066335d 100644 (file)
--- a/src/ngircd/lists.h
+++ b/src/ngircd/lists.h
@@ -7,40 +7,42 @@
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  * Please read the file COPYING, README and AUTHORS for more information.
- *
- * $Id: lists.h,v 1.11 2004/04/25 15:40:19 alex Exp $
- *
- * Management of IRC lists: ban, invite, ... (header)
  */
 
 
 #ifndef __lists_h__
 #define __lists_h__
 
+/**
+ * @file
+ * Management of IRC lists (header)
+ */
 
-GLOBAL VOID Lists_Init PARAMS(( VOID ));
-GLOBAL VOID Lists_Exit PARAMS(( VOID ));
+#include "portab.h"
+#include "client.h"
 
-GLOBAL BOOLEAN Lists_CheckInvited PARAMS(( CLIENT *Client, CHANNEL *Chan ));
-GLOBAL BOOLEAN Lists_AddInvited PARAMS(( CHAR *Mask, CHANNEL *Chan, BOOLEAN OnlyOnce ));
-GLOBAL VOID Lists_DelInvited PARAMS(( CHAR *Mask, CHANNEL *Chan ));
-GLOBAL BOOLEAN Lists_ShowInvites PARAMS(( CLIENT *Client, CHANNEL *Channel ));
-GLOBAL BOOLEAN Lists_SendInvites PARAMS(( CLIENT *Client ));
-GLOBAL BOOLEAN Lists_IsInviteEntry PARAMS(( CHAR *Mask, CHANNEL *Chan ));
+struct list_elem;
 
-GLOBAL BOOLEAN Lists_CheckBanned PARAMS(( CLIENT *Client, CHANNEL *Chan ));
-GLOBAL BOOLEAN Lists_AddBanned PARAMS(( CHAR *Mask, CHANNEL *Chan ));
-GLOBAL VOID Lists_DelBanned PARAMS(( CHAR *Mask, CHANNEL *Chan ));
-GLOBAL BOOLEAN Lists_ShowBans PARAMS(( CLIENT *Client, CHANNEL *Channel ));
-GLOBAL BOOLEAN Lists_SendBans PARAMS(( CLIENT *Client ));
-GLOBAL BOOLEAN Lists_IsBanEntry PARAMS(( CHAR *Mask, CHANNEL *Chan ));
+struct list_head {
+       struct list_elem *first;
+};
 
-GLOBAL VOID Lists_DeleteChannel PARAMS(( CHANNEL *Chan ));
 
-GLOBAL CHAR *Lists_MakeMask PARAMS(( CHAR *Pattern ));
+GLOBAL struct list_elem *Lists_GetFirst PARAMS((const struct list_head *));
+GLOBAL struct list_elem *Lists_GetNext PARAMS((const struct list_elem *));
 
+GLOBAL bool Lists_Check PARAMS((struct list_head *head, CLIENT *client ));
+GLOBAL bool Lists_CheckDupeMask PARAMS((const struct list_head *head, const char *mask ));
 
-#endif
+GLOBAL bool Lists_Add PARAMS((struct list_head *header, const char *Mask, bool OnlyOnce ));
+GLOBAL void Lists_Del PARAMS((struct list_head *head, const char *Mask ));
 
+GLOBAL bool Lists_AlreadyRegistered PARAMS(( const struct list_head *head, const char *Mask));
 
+GLOBAL void Lists_Free PARAMS(( struct list_head *head ));
+
+GLOBAL const char *Lists_MakeMask PARAMS((const char *Pattern));
+GLOBAL const char *Lists_GetMask PARAMS(( const struct list_elem *e ));
+
+#endif
 /* -eof- */