From ba98faf0d8d95b7490e5508e123a06ba6c7489be Mon Sep 17 00:00:00 2001
From: brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Sun, 17 Jun 2007 18:26:13 +0000
Subject: Doxygen comments for command handlers

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@7376 e03df62e-2008-0410-955e-edbf42e46eb7
---
 include/commands/cmd_part.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'include/commands/cmd_part.h')

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);
 };
 
-- 
cgit v1.2.3