X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Finspstring.h;h=54bb1c8bd641927e0546b67dfae7b293f134cb28;hb=219993bc9018d9f0d9568330d7a972b68b785d27;hp=1e6ba68e666063f0b6be56211170909f155f10a9;hpb=9cf56d917d92959701694477f7944d45ad2c38ed;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/inspstring.h b/include/inspstring.h
index 1e6ba68e6..54bb1c8bd 100644
--- a/include/inspstring.h
+++ b/include/inspstring.h
@@ -2,8 +2,8 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
  *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
@@ -14,17 +14,37 @@
 #ifndef __IN_INSPSTRING_H
 #define __IN_INSPSTRING_H
 
+// This (inspircd_config) is needed as inspstring doesn't pull in the central header
 #include "inspircd_config.h"
-#include <string.h>
-#include <cstddef>
+#include <cstring>
+//#include <cstddef>
 
 #ifndef HAS_STRLCPY
+/** strlcpy() implementation for systems that don't have it (linux) */
 CoreExport size_t strlcpy(char *dst, const char *src, size_t siz);
+/** strlcat() implementation for systems that don't have it (linux) */
 CoreExport size_t strlcat(char *dst, const char *src, size_t siz);
 #endif
 
+/** charlcat() will append one character to a string using the same
+ * safety scemantics as strlcat().
+ * @param x The string to operate on
+ * @param y the character to append to the end of x
+ * @param z The maximum allowed length for z including null terminator
+ */
 CoreExport int charlcat(char* x,char y,int z);
+/** charremove() will remove all instances of a character from a string
+ * @param mp The string to operate on
+ * @param remove The character to remove
+ */
 CoreExport bool charremove(char* mp, char remove);
+
+/** strnewdup() is an implemenetation of strdup() which calls operator new
+ * rather than malloc to allocate the new string, therefore allowing it to
+ * be hooked into the C++ memory manager, and freed with operator delete.
+ * This is required for windows, where we override operators new and delete
+ * to allow for global allocation between modules and the core.
+ */
 inline char * strnewdup(const char * s1)
 {
 	size_t len = strlen(s1) + 1;
@@ -34,3 +54,4 @@ inline char * strnewdup(const char * s1)
 }
 
 #endif
+