Needs testbuilding in windows. I will probably do this in a minute.

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

diff --git a/include/command_parse.h b/include/command_parse.h
index cbcbea2d8382b205eaeeefcb6add4e9bf877e85a..e8240fcf9bf1a57a501947ab39a46e79ae3d6795 100644 (file)
--- a/include/command_parse.h
+++ b/include/command_parse.h
@@ -19,8 +19,12 @@
 #include "ctables.h"
 #include "typedefs.h"
 
+/** Required forward declaration
+ */
 class InspIRCd;
 
+/** A list of dll/so files containing the command handlers for the core
+ */
 typedef std::map<std::string, void*> SharedObjectList;
 
 /** This class handles command management and parsing.
@@ -111,6 +115,10 @@ class CoreExport CommandParser : public classbase
         */
        CmdResult CallHandler(const std::string &commandname,const char** parameters, int pcnt, userrec *user);
 
+       /** Get the handler function for a command.
+        * @param commandname The command required. Always use uppercase for this parameter.
+        * @return a pointer to the command handler, or NULL
+        */
        command_t* GetHandler(const std::string &commandname);
 
        /** This function returns true if a command is valid with the given number of parameters and user.