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 420f7751431996823bc119bcd8179afd76f4070d..c39325ea0ea869bf646e5495eeb812fe6066335d 100644 (file)
--- a/src/ngircd/lists.h
+++ b/src/ngircd/lists.h
@@ -7,15 +7,17 @@
  * 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.13 2006/12/07 17:57:20 fw Exp $
- *
- * Management of IRC lists: ban, invite, ... (header)
  */
 
 
 #ifndef __lists_h__
 #define __lists_h__
+
+/**
+ * @file
+ * Management of IRC lists (header)
+ */
+
 #include "portab.h"
 #include "client.h"
 
@@ -39,7 +41,7 @@ GLOBAL bool Lists_AlreadyRegistered PARAMS(( const struct list_head *head, const
 
 GLOBAL void Lists_Free PARAMS(( struct list_head *head ));
 
-GLOBAL char *Lists_MakeMask PARAMS(( char *Pattern ));
+GLOBAL const char *Lists_MakeMask PARAMS((const char *Pattern));
 GLOBAL const char *Lists_GetMask PARAMS(( const struct list_elem *e ));
 
 #endif