Some fixes for doxygen generation

This commit is contained in:
Mark Riddoch
2013-11-25 10:12:08 +01:00
parent 3b0d6c23ad
commit 050ca7ac7e
8 changed files with 24 additions and 38 deletions

View File

@ -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:
* @param dcb - <usage>
* <description>
*
* @return
*
*
* @details Adding to list occurs once per DCB. This is ensured by changing the
* 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>
* <description>
*
* @return
* @param dcb The DCB to close
* @return none
*
*
* @details (write detailed description here)

View File

@ -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 - in, use
* The argument count
*
* @param argv - in, use
* The arguments themselves
* @param argc The argument count
* @param argv The array of arguments themselves
*
* @return 0 in success, 1 otherwise
*

View File

@ -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(

View File

@ -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
*

View File

@ -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 *