X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=src%2Fngircd%2Fngircd.h;h=2efb8a943fb921e52f6574ff8851b424e43bdbdc;hp=fb2379467f7edfbd13756b87d2cade7d7debeb6c;hb=56b7e67307c1be110eaa4e84681bca03df21bd69;hpb=2a7dd06ebd9cc72d45a6a4becdbef5213d7b7800

diff --git a/src/ngircd/ngircd.h b/src/ngircd/ngircd.h
index fb237946..2efb8a94 100644
--- a/src/ngircd/ngircd.h
+++ b/src/ngircd/ngircd.h
@@ -1,52 +1,74 @@
 /*
  * ngIRCd -- The Next Generation IRC Daemon
- * Copyright (c)2001,2002 by Alexander Barton (alex@barton.de)
+ * Copyright (c)2001-2010 Alexander Barton (alex@barton.de).
  *
  * 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.
- *
- * $Id: ngircd.h,v 1.22 2005/06/24 19:20:56 fw Exp $
- *
- * Prototypes of the "main module".
  */
 
 #ifndef __ngircd_h__
 #define __ngircd_h__
 
+/**
+ * @file
+ * Global variables of ngIRCd.
+ */
+
 #include <time.h>
 
 #include "defines.h"
 
 #define C_ARRAY_SIZE(x)	(sizeof(x)/sizeof((x)[0]))
 
+/** UNIX timestamp of ngIRCd start */
+GLOBAL time_t NGIRCd_Start;
 
-GLOBAL time_t NGIRCd_Start;		/* Startzeitpunkt des Daemon */
+/** ngIRCd start time as string, used for RPL_CREATED_MSG (003) */
 GLOBAL char NGIRCd_StartStr[64];
+
+/** ngIRCd version number containing release number and compile-time options */
 GLOBAL char NGIRCd_Version[126];
+
+/** String specifying the compile-time options and target platform */
 GLOBAL char NGIRCd_VersionAddition[126];
 
 #ifdef DEBUG
-GLOBAL bool NGIRCd_Debug;		/* Debug-Modus aktivieren */
+/** Flag indicating if debug mode is active (true) or not (false) */
+GLOBAL bool NGIRCd_Debug;
 #endif
 
 #ifdef SNIFFER
-GLOBAL bool NGIRCd_Sniffer;		/* Sniffer aktivieren */
+/** Flag indication if sniffer is active (true) or not (false) */
+GLOBAL bool NGIRCd_Sniffer;
 #endif
 
-GLOBAL bool NGIRCd_Passive;		/* nicht zu anderen Servern connecten */
+/**
+ * Flag indicating if NO outgoing connections should be established (true)
+ * or not (false, the default)
+ */
+GLOBAL bool NGIRCd_Passive;
 
-GLOBAL bool NGIRCd_SignalQuit;	/* true: quit server*/
-GLOBAL bool NGIRCd_SignalRestart;	/* true: restart server */
+/** Flag indicating that ngIRCd has been requested to quit (true) */
+GLOBAL bool NGIRCd_SignalQuit;
 
-GLOBAL char NGIRCd_DebugLevel[2];	/* Debug-Level fuer IRC_VERSION() */
+/** Flag indicating that ngIRCd has been requested to restart (true) */
+GLOBAL bool NGIRCd_SignalRestart;
 
-GLOBAL char NGIRCd_ConfFile[FNAME_LEN];	/* Konfigurationsdatei */
+/**
+ * Debug level for "VERSION" command, see description of numeric RPL_VERSION
+ * (351) in RFC 2812. ngIRCd sets debuglevel to 1 when the debug mode is
+ * active, and to 2 if the sniffer is running.
+ */
+GLOBAL char NGIRCd_DebugLevel[2];
 
-GLOBAL char NGIRCd_ProtoID[COMMAND_LEN];/* Protokoll- und Server-Identifikation */
+/** Full path and file name of current configuration file */
+GLOBAL char NGIRCd_ConfFile[FNAME_LEN];
 
+/** Protocol and server identification string; see doc/Protocol.txt */
+GLOBAL char NGIRCd_ProtoID[COMMAND_LEN];
 
 #endif