Documentation update, 09/02/03

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

1 files changed, 20 insertions, 8 deletions

diff --git a/include/ctables.h b/include/ctables.h
index e422e1661..5ca5e13b3 100644
--- a/include/ctables.h
+++ b/include/ctables.h
@@ -22,17 +22,29 @@
 
 typedef void (handlerfunc) (char**, int, userrec*);
 
-/* a structure that defines a command */
-
+/** A structure that defines a command
+ */
 class command_t : public classbase
 {
  public:
-	char command[MAXBUF]; /* command name */
-	handlerfunc *handler_function; /* handler function as in typedef */
-	char flags_needed; /* user flags needed to execute the command or 0 */
-	int min_params; /* minimum number of parameters command takes */
-	long use_count; /* used by /stats m */
-	long total_bytes; /* used by /stats m */
+    /** Command name
+     */
+	char command[MAXBUF];
+	/** Handler function as in typedef
+     */
+	handlerfunc *handler_function; 
+	/** User flags needed to execute the command or 0
+	 */
+	char flags_needed;
+    /** Minimum number of parameters command takes
+     */
+	int min_params;
+	/** used by /stats m
+	 */
+	long use_count;
+	/** used by /stats m
+ 	 */
+	long total_bytes;
 };
 
 #endif