Some fixes for doxygen generation

README

@@ -23,7 +23,7 @@ function pointers. This structured is called the "module object".
 The code that routes the queries to the database servers is also loaed
 as external shared objects and are referred to as routing modules.
 
-\section Building Building the MaxScale
+\section Building Building MaxScale
 
 Edit the file build_gateway.inc in your skygateway directory and set
 the ROOT_PATH and MARIADB_SRC_PATH variables to the location in which
@@ -53,7 +53,7 @@ Two files are required for the libmysqld library that is used within MaxScale,
 [mysqld]
 max_connections=4096
 
-\section Running  Running the MaxScale
+\section Running  Running MaxScale
 
 The gateway consists of a core executable and a number of modules that implement
 the different protocols and routing algorithms. These modules are built as

build_gateway.inc

@@ -23,10 +23,10 @@ UNIX :=
 # makefile.inc and build_gateway.inc are located.
 # ROOT_PATH is used in makefile.
 #
-ROOT_PATH := /home/jdoe/skysql/maxscale
+ROOT_PATH := /home/mriddoch/Repository/maxscale
 
 # MARIADB_SRC_PATH may be defined either as an environment variable or
 # specifically here
-ifndef MARIADB_SRC_PATH
+ifndef $(MARIADB_SRC_PATH)
-       MARIADB_SRC_PATH := /home/jdoe/mariadb/5.5
+       MARIADB_SRC_PATH := /packages/mariadb-5.5.25
 endif

server/core/dcb.c

@@ -136,19 +136,13 @@ if ((rval = calloc(1, sizeof(DCB))) == NULL)
 }
 
 /** 
- * @node DCB is added to the end of zombies list. 
+ * Add the DCB to the end of zombies list. 
  *
- * Parameters:
+ * Adding to list occurs once per DCB. This is ensured by changing the
- * @param dcb - <usage>
- *          <description>
- *
- * @return 
- *
- * 
- * @details Adding to list occurs once per DCB. This is ensured by changing the
  * state of DCB to DCB_STATE_ZOMBIE after addition. Prior insertion, DCB state
  * is checked and operation proceeds only if state differs from DCB_STATE_ZOMBIE.
- *
+ * @param dcb The DCB to add to the zombie list
+ * @return none
  */
 void
 dcb_add_to_zombieslist(DCB *dcb)
@@ -878,16 +872,14 @@ int saved_errno = 0;
 }
 
 /** 
- * @node Removes dcb from poll set, and adds it to zombies list. As a consequense,
+ * Removes dcb from poll set, and adds it to zombies list. As a consequense,
  * dcb first moves to DCB_STATE_NOPOLLING, and then to DCB_STATE_ZOMBIE state.
  * At the end of the function state may not be DCB_STATE_ZOMBIE because once dcb_initlock
  * is released parallel threads may change the state.
  *
  * Parameters:
- * @param dcb - <usage>
+ * @param dcb The DCB to close
- *          <description>
+ * @return none
- *
- * @return 
  *
  * 
  * @details (write detailed description here)

server/core/gateway.c

@@ -381,14 +381,10 @@ static void print_log_n_stderr(
 
 
 /** 
- * @node The main entry point into the gateway 
+ * The main entry point into the gateway 
  *
- * Parameters:
+ * @param argc The argument count
- * @param argc - in, use
+ * @param argv The array of arguments themselves
- *          The argument count
- *
- * @param argv - in, use
- *          The arguments themselves
  *
  * @return 0 in success, 1 otherwise
  *

server/core/hashtable.c

@@ -332,7 +332,7 @@ HASHENTRIES	*entries;
 }
 
 /** 
- * @node Produces stat output about hashtable 
+ * Produces stat output about hashtable 
  *
  * Parameters:
  * @param table - <usage>
@@ -349,8 +349,6 @@ HASHENTRIES	*entries;
  *
  * @return void
  *
- * 
- * @details (write detailed description here)
  *
  */
 void hashtable_get_stats(

server/core/poll.c

@@ -213,8 +213,9 @@ return_rc:
 }
 
 #define	BLOCKINGPOLL	0	/* Set BLOCKING POLL to 1 if using a single thread and to make
-* debugging easier.
+				 * debugging easier.
-*/
+				 */
+
 /**
  * The main polling loop
  *

server/core/session.c

@@ -54,7 +54,7 @@ static SESSION	*allSessions = NULL;
  * service this session is part of.
  *
  * @param service	The service this connection was established by
- * @param client	The client side DCB
+ * @param client_dcb	The client side DCB
  * @return		The newly created session or NULL if an error occured
  */
 SESSION *

server/modules/protocol/mysql_common.c

@@ -40,11 +40,10 @@ extern int gw_error_backend_event(DCB *dcb);
 
 
 /** 
- * @node Creates MySQL protocol structure 
+ * Creates MySQL protocol structure 
  *
- * Parameters:
+ * @param dcb *          Must be non-NULL.
- * @param dcb - in, use
+ * @param fd	
- *          Must be non-NULL.
  *
  * @return 
  *
@@ -295,7 +294,7 @@ int gw_decode_mysql_server_handshake(MySQLProtocol *conn, uint8_t *payload) {
 /**
  * Receive the MySQL authentication packet from backend, packet # is 2
  *
- * @param conn The MySQL protocol structure
+ * @param protocol The MySQL protocol structure
  * @return -1 in case of failure, 0 if there was nothing to read, 1 if read
  * was successful.
  */