updates.

[silc.git] / lib / silccore / silcmode.h

diff --git a/lib/silccore/silcmode.h b/lib/silccore/silcmode.h
index ab42a12fb7cd9749e4b15a8a67a2db5e8758ade7..e268f225d28541b7b3c098f3a55fb7f58ff65e31 100644 (file)
--- a/lib/silccore/silcmode.h
+++ b/lib/silccore/silcmode.h
@@ -1,27 +1,44 @@
-/*
-
-  silcmode.h
-
-  Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
-
-  Copyright (C) 2001 Pekka Riikonen
-
-  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.
-  
-  This program is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-
-*/
+/****h* silccore/silcmode.h
+ *
+ * NAME
+ *
+ * silcmode.h
+ *
+ * COPYRIGHT
+ *
+ * Author: Pekka Riikonen <priikone@poseidon.pspt.fi>
+ *
+ * Copyright (C) 2001 Pekka Riikonen
+ *
+ * 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.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * DESCRIPTION
+ *
+ * This header includes all mode definitions for the SILC. It includes
+ * channel modes, channel user mode and user modes.
+ *
+ ***/
 
 #ifndef SILCMODE_H
 #define SILCMODE_H
 
-/* Channel modes */
+
+/****d* silccore/Modes/ChannelModes
+ *
+ * DESCRIPTION
+ *
+ *    All channel modes.
+ *
+ * SOURCE
+ */
 #define SILC_CHANNEL_MODE_NONE         0x0000
 #define SILC_CHANNEL_MODE_PRIVATE      0x0001 /* private channel */
 #define SILC_CHANNEL_MODE_SECRET       0x0002 /* secret channel */
@@ -33,16 +50,34 @@
 #define SILC_CHANNEL_MODE_CIPHER       0x0080 /* sets cipher of the channel */
 #define SILC_CHANNEL_MODE_HMAC         0x0100 /* sets hmac of the channel */
 #define SILC_CHANNEL_MODE_FOUNDER_AUTH 0x0200 /* sets founder auth data */
+/***/
 
-/* User modes on channel */
+/****d* silccore/Modes/ChannelModes
+ *
+ * DESCRIPTION
+ *
+ *    All user modes on channel
+ *
+ * SOURCE
+ */
 #define SILC_CHANNEL_UMODE_NONE        0x0000 /* Normal user */
 #define SILC_CHANNEL_UMODE_CHANFO      0x0001 /* channel founder */
 #define SILC_CHANNEL_UMODE_CHANOP      0x0002 /* channel operator */
+/***/
 
-/* SILC modes */
+/****d* silccore/Modes/ChannelModes
+ *
+ * DESCRIPTION
+ *
+ *    SILC User modes. These indicate the status of the client in the
+ *    SILC network.
+ *
+ * SOURCE
+ */
 #define SILC_UMODE_NONE                0x0000 /* Normal SILC user */
 #define SILC_UMODE_SERVER_OPERATOR     0x0001 /* Server operator */
 #define SILC_UMODE_ROUTER_OPERATOR     0x0002 /* Router (SILC) operator */
 #define SILC_UMODE_GONE                0x0004 /* Client is gone */
+/***/
 
 #endif