Add Doxygen @file documentation to each source and header file

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

diff --git a/src/ngircd/channel.h b/src/ngircd/channel.h
index 3aa1853dd1b344beb4d0117a79e65b632445ec74..32623758744f9acc5f120f6c69621d7f8ff2ef51 100644 (file)
--- a/src/ngircd/channel.h
+++ b/src/ngircd/channel.h
@@ -1,20 +1,22 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001-2008 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2011 Alexander Barton (alex@barton.de) and Contributors.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * 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.
- *
- * Channel management (header)
  */
 
 
 #ifndef __channel_h__
 #define __channel_h__
 
+/**
+ * @file
+ * Channel management (header)
+ */
 
 #if defined(__channel_c__) | defined(S_SPLINT_S)
 
@@ -30,6 +32,7 @@ typedef struct _CHANNEL
        char modes[CHANNEL_MODE_LEN];   /* Channel modes */
        array topic;                    /* Topic of the channel */
 #ifndef STRICT_RFC
+       time_t creation_time;           /* Channel creation time */
        time_t topic_time;              /* Time when topic was set */
        char topic_who[CLIENT_NICK_LEN];/* Nickname of user that set topic */
 #endif
@@ -37,7 +40,7 @@ typedef struct _CHANNEL
        unsigned long maxusers;         /* Maximum number of members (mode "l") */
        struct list_head list_bans;     /* list head of banned users */
        struct list_head list_invites;  /* list head of invited users */
-       FILE *keyfile;                  /* handle of the channel key file */
+       array keyfile;                  /* Name of the channel key file */
 } CHANNEL;
 
 typedef struct _CLIENT2CHAN
@@ -62,10 +65,10 @@ GLOBAL void Channel_Init PARAMS(( void ));
 GLOBAL void Channel_InitPredefined PARAMS((  void ));
 GLOBAL void Channel_Exit PARAMS(( void ));
 
-GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, char *Name ));
+GLOBAL bool Channel_Join PARAMS(( CLIENT *Client, const char *Name ));
 GLOBAL bool Channel_Part PARAMS(( CLIENT *Client, CLIENT *Origin, const char *Name, const char *Reason ));
 
-GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, char *Reason ));
+GLOBAL void Channel_Quit PARAMS(( CLIENT *Client, const char *Reason ));
 
 GLOBAL void Channel_Kick PARAMS((CLIENT *Peer, CLIENT *Target, CLIENT *Origin,
                                 const char *Name, const char *Reason));
@@ -81,7 +84,7 @@ GLOBAL char *Channel_Key PARAMS(( CHANNEL *Chan ));
 GLOBAL unsigned long Channel_MaxUsers PARAMS(( CHANNEL *Chan ));
 
 GLOBAL void Channel_SetTopic PARAMS(( CHANNEL *Chan, CLIENT *Client, const char *Topic ));
-GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, char *Modes ));
+GLOBAL void Channel_SetModes PARAMS(( CHANNEL *Chan, const char *Modes ));
 GLOBAL void Channel_SetKey PARAMS(( CHANNEL *Chan, const char *Key ));
 GLOBAL void Channel_SetMaxUsers PARAMS(( CHANNEL *Chan, unsigned long Count ));
 
@@ -118,6 +121,7 @@ GLOBAL CHANNEL *Channel_Create PARAMS(( const char *Name ));
 #ifndef STRICT_RFC
 GLOBAL unsigned int Channel_TopicTime PARAMS(( CHANNEL *Chan ));
 GLOBAL char *Channel_TopicWho PARAMS(( CHANNEL *Chan ));
+GLOBAL unsigned int Channel_CreationTime PARAMS(( CHANNEL *Chan ));
 #endif
 
 GLOBAL bool Channel_AddInvite PARAMS((CHANNEL *c, const char *Mask, bool OnlyOnce ));
@@ -126,13 +130,17 @@ GLOBAL bool Channel_AddBan PARAMS((CHANNEL *c, const char *Mask ));
 GLOBAL bool Channel_ShowBans PARAMS((CLIENT *client, CHANNEL *c));
 GLOBAL bool Channel_ShowInvites PARAMS((CLIENT *client, CHANNEL *c));
 
-GLOBAL void Channel_LogServer PARAMS((char *msg));
+GLOBAL void Channel_LogServer PARAMS((const char *msg));
 
 GLOBAL bool Channel_CheckKey PARAMS((CHANNEL *Chan, CLIENT *Client,
                                     const char *Key));
 
-#define Channel_IsLocal(c) (Channel_Name(c)[0] == '&')
+GLOBAL void Channel_CheckAdminRights PARAMS((CHANNEL *Chan, CLIENT *Client,
+                                            CLIENT *Origin, bool *OnChannel,
+                                            bool *AdminOk, bool *UseServerMode));
 
+#define Channel_IsLocal(c) (Channel_Name(c)[0] == '&')
+#define Channel_IsModeless(c) (Channel_Name(c)[0] == '+')
 
 #endif