From 7c0c957577a195b4819e4d7f2c9672d7c7522b0d Mon Sep 17 00:00:00 2001
From: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Fri, 15 Sep 2006 14:25:10 +0000
Subject: Annotations

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@5255 e03df62e-2008-0410-955e-edbf42e46eb7
---
 src/cmd_admin.cpp                     | 4 ++--
 src/cmd_away.cpp                      | 4 ++--
 src/cmd_commands.cpp                  | 4 ++--
 src/cmd_connect.cpp                   | 3 ++-
 src/cmd_die.cpp                       | 4 ++--
 src/cmd_eline.cpp                     | 4 ++--
 src/cmd_gline.cpp                     | 4 ++--
 src/cmd_info.cpp                      | 4 ++--
 src/cmd_invite.cpp                    | 4 ++--
 src/cmd_ison.cpp                      | 4 ++--
 src/cmd_join.cpp                      | 4 ++--
 src/cmd_kick.cpp                      | 4 ++--
 src/cmd_kill.cpp                      | 4 ++--
 src/cmd_kline.cpp                     | 4 ++--
 src/cmd_links.cpp                     | 4 ++--
 src/cmd_list.cpp                      | 4 ++--
 src/cmd_loadmodule.cpp                | 4 ++--
 src/cmd_lusers.cpp                    | 4 ++--
 src/cmd_map.cpp                       | 4 ++--
 src/cmd_mode.cpp                      | 2 ++
 src/cmd_modules.cpp                   | 4 ++--
 src/cmd_motd.cpp                      | 4 ++--
 src/cmd_names.cpp                     | 4 ++--
 src/modules/extra/m_ssl_oper_cert.cpp | 2 ++
 src/modules/m_cban.cpp                | 2 ++
 src/modules/m_check.cpp               | 4 ++--
 src/modules/m_chghost.cpp             | 4 ++--
 src/modules/m_chgident.cpp            | 4 ++--
 src/modules/m_devoice.cpp             | 4 ++--
 src/modules/m_globalload.cpp          | 5 ++++-
 src/modules/m_globops.cpp             | 4 ++--
 src/modules/m_opermd5.cpp             | 4 ++++
 src/modules/m_opersha256.cpp          | 4 ++++
 src/modules/m_remove.cpp              | 6 ++++++
 34 files changed, 78 insertions(+), 54 deletions(-)

(limited to 'src')

diff --git a/src/cmd_admin.cpp b/src/cmd_admin.cpp
index 5b04bafb7..28136823c 100644
--- a/src/cmd_admin.cpp
+++ b/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);
diff --git a/src/cmd_away.cpp b/src/cmd_away.cpp
index aecc711e4..2fcb6fbe6 100644
--- a/src/cmd_away.cpp
+++ b/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]))
diff --git a/src/cmd_commands.cpp b/src/cmd_commands.cpp
index b6c0b1a24..423742bb7 100644
--- a/src/cmd_commands.cpp
+++ b/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);
diff --git a/src/cmd_connect.cpp b/src/cmd_connect.cpp
index 4c1d6d7a9..e159719d5 100644
--- a/src/cmd_connect.cpp
+++ b/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);
diff --git a/src/cmd_die.cpp b/src/cmd_die.cpp
index 06b8b79e8..e30f3a190 100644
--- a/src/cmd_die.cpp
+++ b/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))
diff --git a/src/cmd_eline.cpp b/src/cmd_eline.cpp
index 3a11fe024..277367b45 100644
--- a/src/cmd_eline.cpp
+++ b/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)
diff --git a/src/cmd_gline.cpp b/src/cmd_gline.cpp
index aff9fcc63..d1432bd0c 100644
--- a/src/cmd_gline.cpp
+++ b/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)
diff --git a/src/cmd_info.cpp b/src/cmd_info.cpp
index b3be9659a..f61bb119c 100644
--- a/src/cmd_info.cpp
+++ b/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);
diff --git a/src/cmd_invite.cpp b/src/cmd_invite.cpp
index 587dbc5f3..ccac0df7b 100644
--- a/src/cmd_invite.cpp
+++ b/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;
diff --git a/src/cmd_ison.cpp b/src/cmd_ison.cpp
index 72f5ded7c..40c56cffb 100644
--- a/src/cmd_ison.cpp
+++ b/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];
diff --git a/src/cmd_join.cpp b/src/cmd_join.cpp
index 89483e1b4..0ec87b03d 100644
--- a/src/cmd_join.cpp
+++ b/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)
diff --git a/src/cmd_kick.cpp b/src/cmd_kick.cpp
index b20266e29..d11295b9e 100644
--- a/src/cmd_kick.cpp
+++ b/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];
diff --git a/src/cmd_kill.cpp b/src/cmd_kill.cpp
index dfcf99590..4d1a6d4ff 100644
--- a/src/cmd_kill.cpp
+++ b/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]);
diff --git a/src/cmd_kline.cpp b/src/cmd_kline.cpp
index a72ea085d..de9d5bc89 100644
--- a/src/cmd_kline.cpp
+++ b/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)
diff --git a/src/cmd_links.cpp b/src/cmd_links.cpp
index edb27ea31..ab090956b 100644
--- a/src/cmd_links.cpp
+++ b/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);
diff --git a/src/cmd_list.cpp b/src/cmd_list.cpp
index a5f5ed75f..eaf96c097 100644
--- a/src/cmd_list.cpp
+++ b/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);
diff --git a/src/cmd_loadmodule.cpp b/src/cmd_loadmodule.cpp
index 5e0c7ab6f..46c191f69 100644
--- a/src/cmd_loadmodule.cpp
+++ b/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]))
diff --git a/src/cmd_lusers.cpp b/src/cmd_lusers.cpp
index 93b87a94d..4381cdacc 100644
--- a/src/cmd_lusers.cpp
+++ b/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
diff --git a/src/cmd_map.cpp b/src/cmd_map.cpp
index a44030eeb..90e4f6fcd 100644
--- a/src/cmd_map.cpp
+++ b/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
diff --git a/src/cmd_mode.cpp b/src/cmd_mode.cpp
index 545a14f8d..d7efb5155 100644
--- a/src/cmd_mode.cpp
+++ b/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);
diff --git a/src/cmd_modules.cpp b/src/cmd_modules.cpp
index f3f12eaed..22e3a32bb 100644
--- a/src/cmd_modules.cpp
+++ b/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++)
diff --git a/src/cmd_motd.cpp b/src/cmd_motd.cpp
index 44c6fba9e..424a38794 100644
--- a/src/cmd_motd.cpp
+++ b/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();
diff --git a/src/cmd_names.cpp b/src/cmd_names.cpp
index 8302136eb..5eca4352a 100644
--- a/src/cmd_names.cpp
+++ b/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;
diff --git a/src/modules/extra/m_ssl_oper_cert.cpp b/src/modules/extra/m_ssl_oper_cert.cpp
index 2d626e77d..1f11e9b68 100644
--- a/src/modules/extra/m_ssl_oper_cert.cpp
+++ b/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:
diff --git a/src/modules/m_cban.cpp b/src/modules/m_cban.cpp
index a7af325b9..ce2550ba3 100644
--- a/src/modules/m_cban.cpp
+++ b/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:
diff --git a/src/modules/m_check.cpp b/src/modules/m_check.cpp
index 4f153d496..86bc9cef5 100644
--- a/src/modules/m_check.cpp
+++ b/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:
diff --git a/src/modules/m_chghost.cpp b/src/modules/m_chghost.cpp
index 18853ac2d..3a80ceb1a 100644
--- a/src/modules/m_chghost.cpp
+++ b/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:
diff --git a/src/modules/m_chgident.cpp b/src/modules/m_chgident.cpp
index ec136ebdb..412c3a6a5 100644
--- a/src/modules/m_chgident.cpp
+++ b/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:
diff --git a/src/modules/m_devoice.cpp b/src/modules/m_devoice.cpp
index fb5b4bc83..c1f4e3bc8 100644
--- a/src/modules/m_devoice.cpp
+++ b/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:
diff --git a/src/modules/m_globalload.cpp b/src/modules/m_globalload.cpp
index e65f90b64..4992b47af 100644
--- a/src/modules/m_globalload.cpp
+++ b/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:
diff --git a/src/modules/m_globops.cpp b/src/modules/m_globops.cpp
index 5cd17841d..c7889f1a7 100644
--- a/src/modules/m_globops.cpp
+++ b/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:
diff --git a/src/modules/m_opermd5.cpp b/src/modules/m_opermd5.cpp
index 723513de8..1e085deae 100644
--- a/src/modules/m_opermd5.cpp
+++ b/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:
diff --git a/src/modules/m_opersha256.cpp b/src/modules/m_opersha256.cpp
index 40fa3e949..44b2c936d 100644
--- a/src/modules/m_opersha256.cpp
+++ b/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:
diff --git a/src/modules/m_remove.cpp b/src/modules/m_remove.cpp
index 36f056451..eeb5ee1a1 100644
--- a/src/modules/m_remove.cpp
+++ b/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:
-- 
cgit v1.2.3