Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/lists.c b/src/ngircd/lists.c
index 4f9a8855e043510df2c10a939ca115ef6743e6da..cde928f6bf9c0301b260d5fb25b1cf89b2dbfaca 100644 (file)
--- a/src/ngircd/lists.c
+++ b/src/ngircd/lists.c
@@ -7,21 +7,21 @@
  * 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.
- *
- * Management of IRC lists: ban, invite, ...
  */
 
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: lists.c,v 1.20 2006/12/07 17:57:20 fw Exp $";
+/**
+ * @file
+ * Management of IRC lists: ban, invite, etc.
+ */
 
 #include "imp.h"
 #include <assert.h>
 
 #include "defines.h"
 #include "conn.h"
-#include "client.h"
 #include "channel.h"
 #include "log.h"
 #include "match.h"
@@ -80,7 +80,7 @@ Lists_Add(struct list_head *header, const char *Mask, bool OnlyOnce )
        newelem = malloc(sizeof(struct list_elem));
        if( ! newelem ) {
                Log( LOG_EMERG, "Can't allocate memory for new Ban/Invite entry!" );
-               return NULL;
+               return false;
        }
 
        strlcpy( newelem->mask, Mask, sizeof( newelem->mask ));
@@ -88,7 +88,6 @@ Lists_Add(struct list_head *header, const char *Mask, bool OnlyOnce )
        newelem->next = e;
        header->first = newelem;
 
-       LogDebug("Added \"%s\" to invite list", Mask);
        return true;
 }
 
@@ -162,8 +161,8 @@ Lists_CheckDupeMask(const struct list_head *h, const char *Mask )
 }
 
 
-GLOBAL char *
-Lists_MakeMask( char *Pattern )
+GLOBAL const char *
+Lists_MakeMask(const char *Pattern)
 {
        /* This function generats a valid IRC mask of "any" string. This
         * mask is only valid until the next call to Lists_MakeMask(),