Update comments for server commands to doxygen style

2009-03-22 09:15:25 +00:00
parent 54151d50e1
commit 92185c9ea0
12 changed files with 132 additions and 141 deletions
@@ -1,4 +1,4 @@
-/* \file server/commands/command_list.h
+/** \file server/commands/command_list.h
 * Declares client command dispatcher function.
 */

@@ -15,16 +15,16 @@

 #include "../client.h"

-/*
-  The function list for clients is stored in a table, and the items each
-  point to a function to call, defined below.
+/**
+ * The function list for clients is stored in a table, and the items each
+ * point to a function to call, defined below.
 */
-
 typedef int (*CommandFunc) (Client *c, int argc, char **argv);

+/** Defines an entry in the command table */
 typedef struct client_function {
-	char *keyword;
-	CommandFunc function;
+	char *keyword;		/**< Command string in the protocol */
+	CommandFunc function;	/**< Pointer to the associated function */
 } client_function;