diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2007-06-17 18:26:13 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2007-06-17 18:26:13 +0000 |
commit | ba98faf0d8d95b7490e5508e123a06ba6c7489be (patch) | |
tree | 113a7f2208eae24e1dfd711e7e1e37b06d271cad /include | |
parent | 814047662b5cd1a3fa48ba3e08b76cbaf3f1deba (diff) |
Doxygen comments for command handlers
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7376 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'include')
55 files changed, 336 insertions, 0 deletions
diff --git a/include/commands/cmd_admin.h b/include/commands/cmd_admin.h index 502140f17..108c4aa9f 100644 --- a/include/commands/cmd_admin.h +++ b/include/commands/cmd_admin.h @@ -32,6 +32,12 @@ class cmd_admin : public command_t /** Constructor for admin. */ cmd_admin (InspIRCd* Instance) : command_t(Instance,"ADMIN",0,0) { syntax = "[<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_away.h b/include/commands/cmd_away.h index 3c138dd1d..88d111c78 100644 --- a/include/commands/cmd_away.h +++ b/include/commands/cmd_away.h @@ -33,6 +33,12 @@ class cmd_away : public command_t /** Constructor for away. */ cmd_away (InspIRCd* Instance) : command_t(Instance,"AWAY",0,0) { syntax = "[<message>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_clearcache.h b/include/commands/cmd_clearcache.h index 8a6f8c1e5..6c5d66ac8 100644 --- a/include/commands/cmd_clearcache.h +++ b/include/commands/cmd_clearcache.h @@ -32,6 +32,12 @@ class cmd_clearcache : public command_t /** Constructor for clearcache. */ cmd_clearcache (InspIRCd* Instance) : command_t(Instance,"CLEARCACHE",'o',0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_commands.h b/include/commands/cmd_commands.h index 12f500fbe..62359dd5d 100644 --- a/include/commands/cmd_commands.h +++ b/include/commands/cmd_commands.h @@ -33,6 +33,12 @@ class cmd_commands : public command_t /** Constructor for commands. */ cmd_commands (InspIRCd* Instance) : command_t(Instance,"COMMANDS",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_connect.h b/include/commands/cmd_connect.h index 1fe97809c..01150fc68 100644 --- a/include/commands/cmd_connect.h +++ b/include/commands/cmd_connect.h @@ -33,6 +33,12 @@ class cmd_connect : public command_t /** Constructor for connect. */ cmd_connect (InspIRCd* Instance) : command_t(Instance,"CONNECT",'o',1) { syntax = "<servername> [<remote-server>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_die.h b/include/commands/cmd_die.h index 8232bffdb..e3ee3ab9d 100644 --- a/include/commands/cmd_die.h +++ b/include/commands/cmd_die.h @@ -33,6 +33,12 @@ class cmd_die : public command_t /** Constructor for die. */ cmd_die (InspIRCd* Instance) : command_t(Instance,"DIE",'o',1) { syntax = "<password>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_eline.h b/include/commands/cmd_eline.h index 379915a90..594af9697 100644 --- a/include/commands/cmd_eline.h +++ b/include/commands/cmd_eline.h @@ -33,6 +33,12 @@ class cmd_eline : public command_t /** Constructor for eline. */ cmd_eline (InspIRCd* Instance) : command_t(Instance,"ELINE",'o',1) { syntax = "<ident@host> [<duration> :<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_gline.h b/include/commands/cmd_gline.h index f584488ad..5fc8eccee 100644 --- a/include/commands/cmd_gline.h +++ b/include/commands/cmd_gline.h @@ -33,6 +33,12 @@ class cmd_gline : public command_t /** Constructor for gline. */ cmd_gline (InspIRCd* Instance) : command_t(Instance,"GLINE",'o',1) { syntax = "<ident@host> [<duration> :<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_info.h b/include/commands/cmd_info.h index 912e56f2d..330c8bcf1 100644 --- a/include/commands/cmd_info.h +++ b/include/commands/cmd_info.h @@ -33,6 +33,12 @@ class cmd_info : public command_t /** Constructor for info. */ cmd_info (InspIRCd* Instance) : command_t(Instance,"INFO",0,0) { syntax = "[<servermask>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_invite.h b/include/commands/cmd_invite.h index c7e0dea09..13bd1f35b 100644 --- a/include/commands/cmd_invite.h +++ b/include/commands/cmd_invite.h @@ -33,6 +33,12 @@ class cmd_invite : public command_t /** Constructor for invite. */ cmd_invite (InspIRCd* Instance) : command_t(Instance,"INVITE",0,0) { syntax = "[<nick> <channel>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_ison.h b/include/commands/cmd_ison.h index 6980d37e0..d0be58c23 100644 --- a/include/commands/cmd_ison.h +++ b/include/commands/cmd_ison.h @@ -33,6 +33,12 @@ class cmd_ison : public command_t /** Constructor for ison. */ cmd_ison (InspIRCd* Instance) : command_t(Instance,"ISON",0,0) { syntax = "<nick> {nick}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_join.h b/include/commands/cmd_join.h index ea66ecd5a..6e343bb72 100644 --- a/include/commands/cmd_join.h +++ b/include/commands/cmd_join.h @@ -33,6 +33,12 @@ class cmd_join : public command_t /** Constructor for join. */ cmd_join (InspIRCd* Instance) : command_t(Instance,"JOIN",0,1) { syntax = "<channel>{,<channel>} {<key>{,<key>}}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_kick.h b/include/commands/cmd_kick.h index 1b760c85e..6a44d0c12 100644 --- a/include/commands/cmd_kick.h +++ b/include/commands/cmd_kick.h @@ -33,6 +33,12 @@ class cmd_kick : public command_t /** Constructor for kick. */ cmd_kick (InspIRCd* Instance) : command_t(Instance,"KICK",0,2) { syntax = "<channel> <nick>{,<nick>} [<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_kill.h b/include/commands/cmd_kill.h index ae23b3974..8489599b6 100644 --- a/include/commands/cmd_kill.h +++ b/include/commands/cmd_kill.h @@ -33,6 +33,12 @@ class cmd_kill : public command_t /** Constructor for kill. */ cmd_kill (InspIRCd* Instance) : command_t(Instance,"KILL",'o',2) { syntax = "<nickname> <reason>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_kline.h b/include/commands/cmd_kline.h index e68aa310a..053b7634d 100644 --- a/include/commands/cmd_kline.h +++ b/include/commands/cmd_kline.h @@ -33,6 +33,12 @@ class cmd_kline : public command_t /** Constructor for kline. */ cmd_kline (InspIRCd* Instance) : command_t(Instance,"KLINE",'o',1) { syntax = "<ident@host> [<duration> :<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_links.h b/include/commands/cmd_links.h index 8b06199f8..7d0eee9e5 100644 --- a/include/commands/cmd_links.h +++ b/include/commands/cmd_links.h @@ -33,6 +33,12 @@ class cmd_links : public command_t /** Constructor for links. */ cmd_links (InspIRCd* Instance) : command_t(Instance,"LINKS",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_list.h b/include/commands/cmd_list.h index 1aac0cddc..5c956863d 100644 --- a/include/commands/cmd_list.h +++ b/include/commands/cmd_list.h @@ -33,6 +33,12 @@ class cmd_list : public command_t /** Constructor for list. */ cmd_list (InspIRCd* Instance) : command_t(Instance,"LIST",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_loadmodule.h b/include/commands/cmd_loadmodule.h index 6e8505cd8..40ca03e81 100644 --- a/include/commands/cmd_loadmodule.h +++ b/include/commands/cmd_loadmodule.h @@ -33,6 +33,12 @@ class cmd_loadmodule : public command_t /** Constructor for loadmodule. */ cmd_loadmodule (InspIRCd* Instance) : command_t(Instance,"LOADMODULE",'o',1) { syntax = "<modulename>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_lusers.h b/include/commands/cmd_lusers.h index ebf2db852..8f9226b4e 100644 --- a/include/commands/cmd_lusers.h +++ b/include/commands/cmd_lusers.h @@ -33,6 +33,12 @@ class cmd_lusers : public command_t /** Constructor for lusers. */ cmd_lusers (InspIRCd* Instance) : command_t(Instance,"LUSERS",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_map.h b/include/commands/cmd_map.h index 55a899c84..f1b586c9f 100644 --- a/include/commands/cmd_map.h +++ b/include/commands/cmd_map.h @@ -33,6 +33,12 @@ class cmd_map : public command_t /** Constructor for map. */ cmd_map (InspIRCd* Instance) : command_t(Instance,"MAP",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_mode.h b/include/commands/cmd_mode.h index bdd7f96f3..36e76bf66 100644 --- a/include/commands/cmd_mode.h +++ b/include/commands/cmd_mode.h @@ -32,6 +32,12 @@ class cmd_mode : public command_t /** Constructor for mode. */ cmd_mode (InspIRCd* Instance) : command_t(Instance,"MODE",0,1) { syntax = "<target> <modes> {<mode-parameters>}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_modules.h b/include/commands/cmd_modules.h index 1cdc0fb81..372a87c05 100644 --- a/include/commands/cmd_modules.h +++ b/include/commands/cmd_modules.h @@ -33,6 +33,12 @@ class cmd_modules : public command_t /** Constructor for modules. */ cmd_modules (InspIRCd* Instance) : command_t(Instance,"MODULES",0,0) { syntax = "[debug]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_motd.h b/include/commands/cmd_motd.h index beb31bef3..75162274a 100644 --- a/include/commands/cmd_motd.h +++ b/include/commands/cmd_motd.h @@ -36,6 +36,12 @@ class cmd_motd : public command_t /** Constructor for motd. */ cmd_motd (InspIRCd* Instance) : command_t(Instance,"MOTD",0,0) { syntax = "[<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_names.h b/include/commands/cmd_names.h index 265dd2905..135e7946b 100644 --- a/include/commands/cmd_names.h +++ b/include/commands/cmd_names.h @@ -33,6 +33,12 @@ class cmd_names : public command_t /** Constructor for names. */ cmd_names (InspIRCd* Instance) : command_t(Instance,"NAMES",0,0) { syntax = "{<channel>{,<channel>}}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_nick.h b/include/commands/cmd_nick.h index 73fac8ab4..69df1514e 100644 --- a/include/commands/cmd_nick.h +++ b/include/commands/cmd_nick.h @@ -33,6 +33,12 @@ class cmd_nick : public command_t /** Constructor for nick. */ cmd_nick (InspIRCd* Instance) : command_t(Instance,"NICK",0,1,true) { syntax = "<newnick>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_notice.h b/include/commands/cmd_notice.h index df99d2dcc..ec4372066 100644 --- a/include/commands/cmd_notice.h +++ b/include/commands/cmd_notice.h @@ -33,6 +33,12 @@ class cmd_notice : public command_t /** Constructor for notice. */ cmd_notice (InspIRCd* Instance) : command_t(Instance,"NOTICE",0,2) { syntax = "<target>{,<target>} <message>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_oper.h b/include/commands/cmd_oper.h index 2856ea98f..77c4b0125 100644 --- a/include/commands/cmd_oper.h +++ b/include/commands/cmd_oper.h @@ -35,6 +35,12 @@ class cmd_oper : public command_t /** Constructor for oper. */ cmd_oper (InspIRCd* Instance) : command_t(Instance,"OPER",0,2) { syntax = "<username> <password>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_part.h b/include/commands/cmd_part.h index e513e5ad8..5f5781874 100644 --- a/include/commands/cmd_part.h +++ b/include/commands/cmd_part.h @@ -33,6 +33,12 @@ class cmd_part : public command_t /** Constructor for part. */ cmd_part (InspIRCd* Instance) : command_t(Instance,"PART",0,1) { syntax = "<channel>{,<channel>} [<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_pass.h b/include/commands/cmd_pass.h index 35fa7401e..53addf80f 100644 --- a/include/commands/cmd_pass.h +++ b/include/commands/cmd_pass.h @@ -36,6 +36,12 @@ class cmd_pass : public command_t /** Constructor for pass. */ cmd_pass (InspIRCd* Instance) : command_t(Instance,"PASS",0,1,true) { syntax = "<password>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_ping.h b/include/commands/cmd_ping.h index e73b35a29..c5350eba5 100644 --- a/include/commands/cmd_ping.h +++ b/include/commands/cmd_ping.h @@ -33,6 +33,12 @@ class cmd_ping : public command_t /** Constructor for ping. */ cmd_ping (InspIRCd* Instance) : command_t(Instance,"PING",0,1) { syntax = "<servername> [:<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_pong.h b/include/commands/cmd_pong.h index 1e5d09885..724ed0dfc 100644 --- a/include/commands/cmd_pong.h +++ b/include/commands/cmd_pong.h @@ -34,6 +34,12 @@ class cmd_pong : public command_t /** Constructor for pong. */ cmd_pong (InspIRCd* Instance) : command_t(Instance,"PONG",0,1) { syntax = "<ping-text>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_privmsg.h b/include/commands/cmd_privmsg.h index 7c2b44c28..17b7b0445 100644 --- a/include/commands/cmd_privmsg.h +++ b/include/commands/cmd_privmsg.h @@ -33,6 +33,12 @@ class cmd_privmsg : public command_t /** Constructor for privmsg. */ cmd_privmsg (InspIRCd* Instance) : command_t(Instance,"PRIVMSG",0,2) { syntax = "<target>{,<target>} <message>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_qline.h b/include/commands/cmd_qline.h index 6b84b7a56..5d69f9a9a 100644 --- a/include/commands/cmd_qline.h +++ b/include/commands/cmd_qline.h @@ -33,6 +33,12 @@ class cmd_qline : public command_t /** Constructor for qline. */ cmd_qline (InspIRCd* Instance) : command_t(Instance,"QLINE",'o',1) { syntax = "<nick> [<duration> :<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_quit.h b/include/commands/cmd_quit.h index 18af99fc0..9c80130a2 100644 --- a/include/commands/cmd_quit.h +++ b/include/commands/cmd_quit.h @@ -33,6 +33,12 @@ class cmd_quit : public command_t /** Constructor for quit. */ cmd_quit (InspIRCd* Instance) : command_t(Instance,"QUIT",0,0,true) { syntax = "[<message>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_rehash.h b/include/commands/cmd_rehash.h index edb101dfa..f33ac141d 100644 --- a/include/commands/cmd_rehash.h +++ b/include/commands/cmd_rehash.h @@ -33,6 +33,12 @@ class cmd_rehash : public command_t /** Constructor for rehash. */ cmd_rehash (InspIRCd* Instance) : command_t(Instance,"REHASH",'o',0) { syntax = "[<servermask>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_reloadmodule.h b/include/commands/cmd_reloadmodule.h index 56e60b96d..76bc656f8 100644 --- a/include/commands/cmd_reloadmodule.h +++ b/include/commands/cmd_reloadmodule.h @@ -33,6 +33,12 @@ class cmd_reloadmodule : public command_t /** Constructor for reloadmodule. */ cmd_reloadmodule (InspIRCd* Instance) : command_t(Instance,"RELOADMODULE",'o',1) { syntax = "<modulename>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_restart.h b/include/commands/cmd_restart.h index 46a2e606e..89a217a95 100644 --- a/include/commands/cmd_restart.h +++ b/include/commands/cmd_restart.h @@ -36,6 +36,12 @@ class cmd_restart : public command_t /** Constructor for restart. */ cmd_restart (InspIRCd* Instance) : command_t(Instance,"RESTART",'o',1) { syntax = "<password>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_rules.h b/include/commands/cmd_rules.h index ef0514d3a..ffa7ea8bd 100644 --- a/include/commands/cmd_rules.h +++ b/include/commands/cmd_rules.h @@ -36,6 +36,12 @@ class cmd_rules : public command_t /** Constructor for rules. */ cmd_rules (InspIRCd* Instance) : command_t(Instance,"RULES",0,0) { syntax = "[<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_server.h b/include/commands/cmd_server.h index 5d72f35f9..3c88c0ac6 100644 --- a/include/commands/cmd_server.h +++ b/include/commands/cmd_server.h @@ -33,6 +33,12 @@ class cmd_server : public command_t /** Constructor for server. */ cmd_server (InspIRCd* Instance) : command_t(Instance,"SERVER",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_squit.h b/include/commands/cmd_squit.h index 082ffff6f..43cb115f7 100644 --- a/include/commands/cmd_squit.h +++ b/include/commands/cmd_squit.h @@ -36,6 +36,12 @@ class cmd_squit : public command_t /** Constructor for squit. */ cmd_squit (InspIRCd* Instance) : command_t(Instance,"SQUIT",'o',1) { syntax = "<servername> [<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_stats.h b/include/commands/cmd_stats.h index 33232d450..b4c0c3784 100644 --- a/include/commands/cmd_stats.h +++ b/include/commands/cmd_stats.h @@ -36,6 +36,12 @@ class cmd_stats : public command_t /** Constructor for stats. */ cmd_stats (InspIRCd* Instance) : command_t(Instance,"STATS",0,1) { syntax = "<stats-symbol> [<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_summon.h b/include/commands/cmd_summon.h index 608bfe64c..717863f35 100644 --- a/include/commands/cmd_summon.h +++ b/include/commands/cmd_summon.h @@ -36,6 +36,12 @@ class cmd_summon : public command_t /** Constructor for summon. */ cmd_summon (InspIRCd* Instance) : command_t(Instance,"SUMMON",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_time.h b/include/commands/cmd_time.h index 2cf29c8bc..0a2dc2f95 100644 --- a/include/commands/cmd_time.h +++ b/include/commands/cmd_time.h @@ -33,6 +33,12 @@ class cmd_time : public command_t /** Constructor for time. */ cmd_time (InspIRCd* Instance) : command_t(Instance,"TIME",0,0) { syntax = "[<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_topic.h b/include/commands/cmd_topic.h index ee444f2a8..c3ac113ef 100644 --- a/include/commands/cmd_topic.h +++ b/include/commands/cmd_topic.h @@ -33,6 +33,12 @@ class cmd_topic : public command_t /** Constructor for topic. */ cmd_topic (InspIRCd* Instance) : command_t(Instance,"TOPIC",0,1) { syntax = "<channel> [<topic>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_trace.h b/include/commands/cmd_trace.h index de7867264..2c681363d 100644 --- a/include/commands/cmd_trace.h +++ b/include/commands/cmd_trace.h @@ -33,6 +33,12 @@ class cmd_trace : public command_t /** Constructor for trace. */ cmd_trace (InspIRCd* Instance) : command_t(Instance,"TRACE",'o',0) { syntax = "[<object>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_unloadmodule.h b/include/commands/cmd_unloadmodule.h index 6f0a64a15..2f435576f 100644 --- a/include/commands/cmd_unloadmodule.h +++ b/include/commands/cmd_unloadmodule.h @@ -33,6 +33,12 @@ class cmd_unloadmodule : public command_t /** Constructor for unloadmodule. */ cmd_unloadmodule (InspIRCd* Instance) : command_t(Instance,"UNLOADMODULE",'o',1) { syntax = "<modulename>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_user.h b/include/commands/cmd_user.h index 1678e0af2..eb835e290 100644 --- a/include/commands/cmd_user.h +++ b/include/commands/cmd_user.h @@ -33,6 +33,12 @@ class cmd_user : public command_t /** Constructor for user. */ cmd_user (InspIRCd* Instance) : command_t(Instance,"USER",0,4,true) { syntax = "<username> <localhost> <remotehost> <GECOS>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_userhost.h b/include/commands/cmd_userhost.h index 3f3562ff3..0a72bcda2 100644 --- a/include/commands/cmd_userhost.h +++ b/include/commands/cmd_userhost.h @@ -33,6 +33,12 @@ class cmd_userhost : public command_t /** Constructor for userhost. */ cmd_userhost (InspIRCd* Instance) : command_t(Instance,"USERHOST",0,1) { syntax = "<nick>{,<nick>}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_users.h b/include/commands/cmd_users.h index 4bc383a00..60341871d 100644 --- a/include/commands/cmd_users.h +++ b/include/commands/cmd_users.h @@ -36,6 +36,12 @@ class cmd_users : public command_t /** Constructor for users. */ cmd_users (InspIRCd* Instance) : command_t(Instance,"USERS",0,0) { } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_version.h b/include/commands/cmd_version.h index 2f61954cb..824a9ef7e 100644 --- a/include/commands/cmd_version.h +++ b/include/commands/cmd_version.h @@ -33,6 +33,12 @@ class cmd_version : public command_t /** Constructor for version. */ cmd_version (InspIRCd* Instance) : command_t(Instance,"VERSION",0,0) { syntax = "[<servername>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_wallops.h b/include/commands/cmd_wallops.h index 3bdb1742c..548ba53de 100644 --- a/include/commands/cmd_wallops.h +++ b/include/commands/cmd_wallops.h @@ -33,6 +33,12 @@ class cmd_wallops : public command_t /** Constructor for wallops. */ cmd_wallops (InspIRCd* Instance) : command_t(Instance,"WALLOPS",'o',1) { syntax = "<any-text>"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_who.h b/include/commands/cmd_who.h index 625fdd199..6ccfa3b5d 100644 --- a/include/commands/cmd_who.h +++ b/include/commands/cmd_who.h @@ -46,6 +46,12 @@ class cmd_who : public command_t */ cmd_who (InspIRCd* Instance) : command_t(Instance,"WHO",0,1) { syntax = "<server>|<nickname>|<channel>|<realname>|<host>|0 [ohurmMiaplf]"; } void SendWhoLine(userrec* user, const std::string &initial, chanrec* ch, userrec* u, std::vector<std::string> &whoresults); + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); bool whomatch(userrec* user, const char* matchtext); }; diff --git a/include/commands/cmd_whois.h b/include/commands/cmd_whois.h index db78ec43d..d3086788a 100644 --- a/include/commands/cmd_whois.h +++ b/include/commands/cmd_whois.h @@ -36,6 +36,12 @@ class cmd_whois : public command_t /** Constructor for whois. */ cmd_whois (InspIRCd* Instance) : command_t(Instance,"WHOIS",0,1) { syntax = "<nick>{,<nick>}"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h index c3e00c6de..58aa14bfd 100644 --- a/include/commands/cmd_whowas.h +++ b/include/commands/cmd_whowas.h @@ -76,7 +76,19 @@ class cmd_whowas : public command_t public: cmd_whowas(InspIRCd* Instance); + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> ¶meters); void AddToWhoWas(userrec* user); void GetStats(Extensible* ext); diff --git a/include/commands/cmd_zline.h b/include/commands/cmd_zline.h index dfa607c03..cf9edbfc6 100644 --- a/include/commands/cmd_zline.h +++ b/include/commands/cmd_zline.h @@ -33,6 +33,12 @@ class cmd_zline : public command_t /** Constructor for zline. */ cmd_zline (InspIRCd* Instance) : command_t(Instance,"ZLINE",'o',1) { syntax = "<ipmask> [<duration> :<reason>]"; } + /** Handle command. + * @param parameters The parameters to the comamnd + * @param pcnt The number of parameters passed to teh command + * @param user The user issuing the command + * @return A value from CmdResult to indicate command success or failure. + */ CmdResult Handle(const char** parameters, int pcnt, userrec *user); }; |