Add Doxygen @file documentation to each source and header file

[ngircd.git] / src / tool / tool.h

diff --git a/src/tool/tool.h b/src/tool/tool.h
index 5b386e59c71f19f89f2319a035abee4cec9afb52..ba52f66bb8bc2ff68087ee9c6a51c3a47f08cfe8 100644 (file)
--- a/src/tool/tool.h
+++ b/src/tool/tool.h
@@ -1,29 +1,42 @@
 /*
  * 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: tool.h,v 1.3 2005/03/19 18:43:53 fw Exp $
- *
- * Tool functions (Header)
  */
 
 
 #ifndef __tool_h__
 #define __tool_h__
 
+/**
+ * @file
+ * Tool functions (Header)
+ */
+
+#include "portab.h"
+
+#ifdef HAVE_ARPA_INET_H
+# include <arpa/inet.h>
+#else
+# define PF_INET AF_INET
+#endif
 
 GLOBAL void ngt_TrimLastChr PARAMS((char *String, const char Chr ));
 
 GLOBAL void ngt_TrimStr PARAMS((char *String ));
 
+GLOBAL char *ngt_UpperStr PARAMS((char *String ));
 GLOBAL char *ngt_LowerStr PARAMS((char *String ));
 
+#ifdef SYSLOG
+GLOBAL const char *ngt_SyslogFacilityName PARAMS((int Facility));
+GLOBAL int ngt_SyslogFacilityID PARAMS((char *Name, int DefaultFacility));
+#endif
 
 #endif