Annotations

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5255 e03df62e-2008-0410-955e-edbf42e46eb7

src/cmd_admin.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_admin.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_admin(Instance);
 }
 
+/** Handle /ADMIN
+ */
 CmdResult cmd_admin::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	user->WriteServ("256 %s :Administrative info for %s",user->nick,ServerInstance->Config->ServerName);

src/cmd_away.cpp

@@ -19,13 +19,13 @@
 #include "modules.h"
 #include "commands/cmd_away.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_away(Instance);
 }
 
+/** Handle /AWAY
+ */
 CmdResult cmd_away::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if ((pcnt) && (*parameters[0]))

src/cmd_commands.cpp

@@ -18,8 +18,8 @@
 #include "users.h"
 #include "commands/cmd_commands.h"
 
-
+/** Handle /COMMANDS
-
+ */
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_commands(Instance);

src/cmd_connect.cpp

@@ -21,12 +21,13 @@
  * This is handled by the server linking module, if necessary. Do not remove this stub.
  */
 
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_connect(Instance);
 }
 
+/** Handle /CONNECT
+ */
 CmdResult cmd_connect::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	user->WriteServ( "NOTICE %s :You are a nub. Load a linking module.", user->nick);

src/cmd_die.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_die.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_die(Instance);
 }
 
+/** Handle /DIE
+ */
 CmdResult cmd_die::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (!strcmp(parameters[0],ServerInstance->Config->diepass))

src/cmd_eline.cpp

@@ -20,13 +20,13 @@
 #include "xline.h"
 #include "commands/cmd_eline.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_eline(Instance);
 }
 
+/** Handle /ELINE
+ */
 CmdResult cmd_eline::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (pcnt >= 3)

src/cmd_gline.cpp

@@ -20,13 +20,13 @@
 #include "xline.h"
 #include "commands/cmd_gline.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_gline(Instance);
 }
 
+/** Handle /GLINE
+ */
 CmdResult cmd_gline::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (pcnt >= 3)

src/cmd_info.cpp

@@ -19,13 +19,13 @@
 #include "modules.h"
 #include "commands/cmd_info.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_info(Instance);
 }
 
+/** Handle /INFO
+ */
 CmdResult cmd_info::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	user->WriteServ( "371 %s :. o O (The Inspire Internet Relay Chat Server) O o .", user->nick);

src/cmd_invite.cpp

@@ -19,13 +19,13 @@
 #include "modules.h"
 #include "commands/cmd_invite.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_invite(Instance);
 }
 
+/** Handle /INVITE
+ */
 CmdResult cmd_invite::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	int MOD_RESULT = 0;

src/cmd_ison.cpp

@@ -18,13 +18,13 @@
 #include "inspircd.h"
 #include "commands/cmd_ison.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_ison(Instance);
 }
 
+/** Handle /ISON
+ */
 CmdResult cmd_ison::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	char retbuf[MAXBUF];

src/cmd_join.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_join.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_join(Instance);
 }
 
+/** Handle /JOIN
+ */
 CmdResult cmd_join::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (pcnt > 1)

src/cmd_kick.cpp

@@ -18,13 +18,13 @@
 #include "inspircd.h"
 #include "commands/cmd_kick.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_kick(Instance);
 }
 
+/** Handle /KICK
+ */
 CmdResult cmd_kick::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	char reason[MAXKICK];

src/cmd_kill.cpp

@@ -19,13 +19,13 @@
 #include "modules.h"
 #include "commands/cmd_kill.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_kill(Instance);
 }
 
+/** Handle /KILL
+ */
 CmdResult cmd_kill::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	userrec *u = ServerInstance->FindNick(parameters[0]);

src/cmd_kline.cpp

@@ -20,13 +20,13 @@
 #include "xline.h"
 #include "commands/cmd_kline.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_kline(Instance);
 }
 
+/** Handle /KLINE
+ */
 CmdResult cmd_kline::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (pcnt >= 3)

src/cmd_links.cpp

@@ -19,13 +19,13 @@
 #include "modules.h"
 #include "commands/cmd_links.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_links(Instance);
 }
 
+/** Handle /LINKS
+ */
 CmdResult cmd_links::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	user->WriteServ("364 %s %s %s :0 %s",user->nick,ServerInstance->Config->ServerName,ServerInstance->Config->ServerName,ServerInstance->Config->ServerDesc);

src/cmd_list.cpp

@@ -19,8 +19,8 @@
 #include "commands/cmd_list.h"
 #include "wildcard.h"
 
-
+/** Handle /LIST
-
+ */
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_list(Instance);

src/cmd_loadmodule.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_loadmodule.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_loadmodule(Instance);
 }
 
+/** Handle /LOADMODULE
+ */
 CmdResult cmd_loadmodule::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	if (ServerInstance->LoadModule(parameters[0]))

src/cmd_lusers.cpp

@@ -18,13 +18,13 @@
 #include "inspircd.h"
 #include "commands/cmd_lusers.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_lusers(Instance);
 }
 
+/** Handle /LUSERS
+ */
 CmdResult cmd_lusers::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	// this lusers command shows one server at all times because

src/cmd_map.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_map.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_map(Instance);
 }
 
+/** Handle /MAP
+ */
 CmdResult cmd_map::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	// as with /LUSERS this does nothing without a linking

src/cmd_mode.cpp

@@ -23,6 +23,8 @@ extern "C" command_t* init_command(InspIRCd* Instance)
 	return new cmd_mode(Instance);
 }
 
+/** Handle /MODE
+ */
 CmdResult cmd_mode::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	ServerInstance->Modes->Process(parameters, pcnt, user, false);

src/cmd_modules.cpp

@@ -37,13 +37,13 @@ char* itab[] = {
 	"OnPostCommand", NULL
 };
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_modules(Instance);
 }
 
+/** Handle /MODULES
+ */
 CmdResult cmd_modules::Handle (const char** parameters, int pcnt, userrec *user)
 {
   	for (unsigned int i = 0; i < ServerInstance->Config->module_names.size(); i++)

src/cmd_motd.cpp

@@ -17,13 +17,13 @@
 #include "users.h"
 #include "commands/cmd_motd.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_motd(Instance);
 }
 
+/** Handle /MOTD
+ */
 CmdResult cmd_motd::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	user->ShowMOTD();

src/cmd_names.cpp

@@ -18,13 +18,13 @@
 #include "users.h"
 #include "commands/cmd_names.h"
 
-
-
 extern "C" command_t* init_command(InspIRCd* Instance)
 {
 	return new cmd_names(Instance);
 }
 
+/** Handle /NAMES
+ */
 CmdResult cmd_names::Handle (const char** parameters, int pcnt, userrec *user)
 {
 	chanrec* c;

src/modules/extra/m_ssl_oper_cert.cpp

@@ -27,6 +27,8 @@ using namespace std;
 #include "ssl_cert.h"
 #include "wildcard.h"
 
+/** Handle /FINGERPRINT
+ */
 class cmd_fingerprint : public command_t
 {
  public:

src/modules/m_cban.cpp

@@ -51,6 +51,8 @@ typedef std::vector<CBan> cbanlist;
 /* cbans is declared here, as our type is right above. Don't try move it. */
 cbanlist cbans;
 
+/** Handle /CBAN
+ */
 class cmd_cban : public command_t
 {
  public:

src/modules/m_check.cpp

@@ -24,8 +24,8 @@ using namespace std;
 
 /* $ModDesc: Provides the /check command to retrieve information on a user, channel, or IP address */
 
-
+/** Handle /CHECK
-
+ */
 class cmd_check : public command_t
 {
  public:

src/modules/m_chghost.cpp

@@ -26,8 +26,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for the CHGHOST command */
 
-
+/** Handle /CHGHOST
-
+ */
 class cmd_chghost : public command_t
 {
  public:

src/modules/m_chgident.cpp

@@ -6,8 +6,8 @@
 
 /* $ModDesc: Provides support for the CHGIDENT command */
 
-
+/** Handle /CHGIDENT
-
+ */
 class cmd_chgident : public command_t
 {
  public:

src/modules/m_devoice.cpp

@@ -29,8 +29,8 @@ using namespace std;
 #include "modules.h"
 #include "inspircd.h"
 
-
+/** Handle /DEVOICE
-	 
+ */	 
 class cmd_devoice : public command_t
 {
  public:

src/modules/m_globalload.cpp

@@ -24,7 +24,8 @@ using namespace std;
 #include "modules.h"
 #include "inspircd.h"
 
-
+/** Handle /GLOADMODULE
+ */
 class cmd_gloadmodule : public command_t
 {
  public:
@@ -50,6 +51,8 @@ class cmd_gloadmodule : public command_t
 	}
 };
 
+/** Handle /GUNLOADMODULE
+ */
 class cmd_gunloadmodule : public command_t
 {
  public:

src/modules/m_globops.cpp

@@ -27,8 +27,8 @@ using namespace std;
 
 /* $ModDesc: Provides support for GLOBOPS and user mode +g */
 
-
+/** Handle /GLOBOPS
-
+ */
 class cmd_globops : public command_t
 {
  public:

src/modules/m_opermd5.cpp

@@ -46,6 +46,8 @@ typedef unsigned int uint32_t;
 typedef uint32_t word32; /* NOT unsigned long. We don't support 16 bit platforms, anyway. */
 typedef unsigned char byte;
 
+/** An MD5 context, used by m_opermd5
+ */
 class MD5Context : public classbase
 {
  public:
@@ -269,6 +271,8 @@ void GenHash(const char* src, char* dest)
 	strcpy(dest,hash);
 }
 
+/** Handle /MKPASSWD
+ */
 class cmd_mkpasswd : public command_t
 {
  public:

src/modules/m_opersha256.cpp

@@ -56,6 +56,8 @@ using namespace std;
 typedef unsigned int uint32_t;
 #endif
 
+/** An sha 256 context, used by m_opersha256
+ */
 class SHA256Context : public classbase
 {
  public:
@@ -225,6 +227,8 @@ void SHA256(const char *src, char *dest, int len)
 	}
 }
 
+/** Handle /MKSHA256
+ */
 class cmd_mksha256 : public command_t
 {
 public:

src/modules/m_remove.cpp

@@ -32,6 +32,8 @@
  * eg: +h can remove +hv and users with no modes. +a can remove +aohv and users with no modes.
 */
 
+/** Base class for /FPART and /REMOVE
+ */
 class RemoveBase
 {
  private: 
@@ -220,6 +222,8 @@ class RemoveBase
 	}
 };
 
+/** Handle /REMOVE
+ */
 class cmd_remove : public command_t, public RemoveBase
 {
  public:
@@ -235,6 +239,8 @@ class cmd_remove : public command_t, public RemoveBase
 	}
 };
 
+/** Handle /FPART
+ */
 class cmd_fpart : public command_t, public RemoveBase
 {
  public: