Fix Doxygen syntax errors.

[user/henk/code/inspircd.git] / include / inspircd.h

diff --git a/include/inspircd.h b/include/inspircd.h
index dde5625617c44796a30a7415f68cb902e5b6b64c..2f6fb01f75f702ed430e48c09fce7cc20197dfa5 100644 (file)
--- a/include/inspircd.h
+++ b/include/inspircd.h
@@ -55,7 +55,9 @@
 #include <cstring>
 #include <climits>
 #include <cstdio>
+#ifndef WIN32
 #include <unistd.h>
+#endif
 
 #include <sstream>
 #include <string>
@@ -254,6 +256,8 @@ DEFINE_HANDLER1(IsSIDHandler, bool, const std::string&);
 DEFINE_HANDLER1(RehashHandler, void, const std::string&);
 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 
+class TestSuite;
+
 /** The main class of the irc server.
  * This class contains instances of all the other classes in this software.
  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
@@ -344,16 +348,16 @@ class CoreExport InspIRCd
        static const char LogHeader[];
 
        /** Find a user in the UUID hash
-        * @param nick The nickname to find
+        * @param uid The UUID to find
         * @return A pointer to the user, or NULL if the user does not exist
         */
-       User* FindUUID(const std::string &);
+       User* FindUUID(const std::string &uid);
 
        /** Find a user in the UUID hash
-        * @param nick The nickname to find
+        * @param uid The UUID to find
         * @return A pointer to the user, or NULL if the user does not exist
         */
-       User* FindUUID(const char *);
+       User* FindUUID(const char *uid);
 
        /** Build the ISUPPORT string by triggering all modules On005Numeric events
         */
@@ -456,6 +460,10 @@ class CoreExport InspIRCd
         */
        LocalStringExt OperQuit;
 
+       /** Holds whether the MOTD has been parsed for color codes
+       */
+       bool ProcessedMotdEscapes;
+
        /** Get the current time
         * Because this only calls time() once every time around the mainloop,
         * it is much faster than calling time() directly.
@@ -490,6 +498,7 @@ class CoreExport InspIRCd
         * @param sockfd A valid file descriptor of an open socket
         * @param port The port number to bind to
         * @param addr The address to bind to (IP only)
+        * @param dolisten Should this port be listened on?
         * @return True if the port was bound successfully
         */
        bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
@@ -577,7 +586,7 @@ class CoreExport InspIRCd
        /** Causes the server to exit after unloading modules and
         * closing all open file descriptors.
         *
-        * @param The exit code to give to the operating system
+        * @param status The exit code to give to the operating system
         * (See the ExitStatus enum for valid values)
         */
        void Exit(int status);
@@ -656,6 +665,7 @@ class CoreExport InspIRCd
         * to check case against (may be NULL). If map is null, match will be case insensitive.
         * @param str The literal string to match against
         * @param mask The glob pattern to match against.
+        * @param map The character map to use when matching.
         */
        static bool Match(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
        static bool Match(const  char *str, const char *mask, unsigned const char *map = NULL);
@@ -665,6 +675,7 @@ class CoreExport InspIRCd
         * Supports CIDR patterns as well as globs.
         * @param str The literal string to match against
         * @param mask The glob or CIDR pattern to match against.
+        * @param map The character map to use when matching.
         */
        static bool MatchCIDR(const std::string &str, const std::string &mask, unsigned const char *map = NULL);
        static bool MatchCIDR(const  char *str, const char *mask, unsigned const char *map = NULL);
@@ -672,15 +683,14 @@ class CoreExport InspIRCd
        /** Call the handler for a given command.
         * @param commandname The command whos handler you wish to call
         * @param parameters The mode parameters
-        * @param pcnt The number of items you have given in the first parameter
         * @param user The user to execute the command as
         * @return True if the command handler was called successfully
         */
        CmdResult CallCommandHandler(const std::string &commandname, const std::vector<std::string>& parameters, User* user);
 
        /** Return true if the command is a module-implemented command and the given parameters are valid for it
-        * @param parameters The mode parameters
-        * @param pcnt The number of items you have given in the first parameter
+        * @param commandname The command name to check
+        * @param pcnt The parameter count
         * @param user The user to test-execute the command as
         * @return True if the command handler is a module command, and there are enough parameters and the user has permission to the command
         */
@@ -849,6 +859,8 @@ class CoreExport InspIRCd
        {
                return this->ReadBuffer;
        }
+
+       friend class TestSuite;
 };
 
 ENTRYPOINT;