Misc fixes to doxygen comments
This commit is contained in:
@ -298,11 +298,13 @@ int rval = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Trim bytes form the end of a GWBUF structure
|
||||
* Trim bytes form the end of a GWBUF structure. If the
|
||||
* buffer has n_bytes or less then it will be freed and
|
||||
* NULL will be returned.
|
||||
*
|
||||
* @param buf The buffer to trim
|
||||
* @param nbytes The number of bytes to trim off
|
||||
* @return The buffer chain
|
||||
* @param n_bytes The number of bytes to trim off
|
||||
* @return The buffer chain or NULL if buffer has <= n_bytes
|
||||
*/
|
||||
GWBUF *
|
||||
gwbuf_trim(GWBUF *buf, unsigned int n_bytes)
|
||||
|
||||
@ -1703,14 +1703,15 @@ int gw_write(
|
||||
/**
|
||||
* Add a callback
|
||||
*
|
||||
* Duplicate registrations are not allowed, therefore an error will be returned if
|
||||
* the specific function, reason and userdata triple are already registered.
|
||||
* Duplicate registrations are not allowed, therefore an error will be
|
||||
* returned if the specific function, reason and userdata triple
|
||||
* are already registered.
|
||||
* An error will also be returned if the is insufficient memeory available to
|
||||
* create the registration.
|
||||
*
|
||||
* @param dcb The DCB to add the callback to
|
||||
* @param reason The callback reason
|
||||
* @param cb The callback function to call
|
||||
* @param callback The callback function to call
|
||||
* @param userdata User data to send in the call
|
||||
* @return Non-zero (true) if the callback was added
|
||||
*/
|
||||
@ -1766,7 +1767,7 @@ int rval = 1;
|
||||
*
|
||||
* @param dcb The DCB to add the callback to
|
||||
* @param reason The callback reason
|
||||
* @param cb The callback function to call
|
||||
* @param callback The callback function to call
|
||||
* @param userdata User data to send in the call
|
||||
* @return Non-zero (true) if the callback was removed
|
||||
*/
|
||||
@ -1839,7 +1840,7 @@ DCB_CALLBACK *cb, *nextcb;
|
||||
/**
|
||||
* Check the passed DCB to ensure it is in the list of allDCBS
|
||||
*
|
||||
* @param DCB The DCB to check
|
||||
* @param dcb The DCB to check
|
||||
* @return 1 if the DCB is in the list, otherwise 0
|
||||
*/
|
||||
int
|
||||
@ -1936,8 +1937,8 @@ void dcb_call_foreach (
|
||||
* Null protocol write routine used for cloned dcb's. It merely consumes
|
||||
* buffers written on the cloned DCB.
|
||||
*
|
||||
* @params dcb The descriptor control block
|
||||
* @params buf The buffer beign written
|
||||
* @param dcb The descriptor control block
|
||||
* @param buf The buffer being written
|
||||
* @return Always returns a good write operation result
|
||||
*/
|
||||
static int
|
||||
|
||||
@ -39,8 +39,8 @@
|
||||
|
||||
extern int lm_enabled_logfiles_bitmask;
|
||||
|
||||
static SPINLOCK filter_spin = SPINLOCK_INIT;
|
||||
static FILTER_DEF *allFilters = NULL;
|
||||
static SPINLOCK filter_spin = SPINLOCK_INIT; /**< Protects the list of all filters */
|
||||
static FILTER_DEF *allFilters = NULL; /**< The list of all filters */
|
||||
|
||||
/**
|
||||
* Allocate a new filter within MaxScale
|
||||
@ -79,7 +79,7 @@ FILTER_DEF *filter;
|
||||
/**
|
||||
* Deallocate the specified filter
|
||||
*
|
||||
* @param server The service to deallocate
|
||||
* @param filter The filter to deallocate
|
||||
* @return Returns true if the server was freed
|
||||
*/
|
||||
void
|
||||
@ -243,8 +243,8 @@ int i;
|
||||
/**
|
||||
* Add a router option to a service
|
||||
*
|
||||
* @param service The service to add the router option to
|
||||
* @param option The option string
|
||||
* @param filter The filter to add the option to
|
||||
* @param option The option string
|
||||
*/
|
||||
void
|
||||
filterAddOption(FILTER_DEF *filter, char *option)
|
||||
@ -273,7 +273,7 @@ int i;
|
||||
/**
|
||||
* Add a router parameter to a service
|
||||
*
|
||||
* @param service The service to add the router option to
|
||||
* @param filter The filter to add the parameter to
|
||||
* @param name The parameter name
|
||||
* @param value The parameter value
|
||||
*/
|
||||
|
||||
@ -281,6 +281,7 @@ MODULES *mod = registered;
|
||||
* @param dlhandle The handle returned by dlopen
|
||||
* @param version The version string returned by the module
|
||||
* @param modobj The module object
|
||||
* @param mod_info The module information
|
||||
*/
|
||||
static void
|
||||
register_module(const char *module, const char *type, void *dlhandle, char *version, void *modobj, MODULE_INFO *mod_info)
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
* Encrypt a password for storing in the MaxScale.cnf file
|
||||
*
|
||||
* @param argc Argument count
|
||||
* @param arv Argument vector
|
||||
* @param argv Argument vector
|
||||
*/
|
||||
int
|
||||
main(int argc, char **argv)
|
||||
|
||||
@ -207,7 +207,8 @@ MONITOR *ptr;
|
||||
/**
|
||||
* Show a single monitor
|
||||
*
|
||||
* @param dcb DCB for printing output
|
||||
* @param dcb DCB for printing output
|
||||
* @param monitor The monitor to print information regarding
|
||||
*/
|
||||
void
|
||||
monitorShow(DCB *dcb, MONITOR *monitor)
|
||||
@ -303,7 +304,7 @@ monitorSetInterval (MONITOR *mon, unsigned long interval)
|
||||
* Enable Replication Heartbeat support in monitor.
|
||||
*
|
||||
* @param mon The monitor instance
|
||||
* @param interval The sampling interval in milliseconds
|
||||
* @param replication_heartbeat The replication heartbeat
|
||||
*/
|
||||
void
|
||||
monitorSetReplicationHeartbeat(MONITOR *mon, int replication_heartbeat)
|
||||
|
||||
@ -148,8 +148,7 @@ server_set_unique_name(SERVER *server, char *name)
|
||||
* Find an existing server using the unique section name in
|
||||
* configuration file
|
||||
*
|
||||
* @param servname The Server name or address
|
||||
* @param port The server port
|
||||
* @param name The Server name defined in the header file
|
||||
* @return The server or NULL if not found
|
||||
*/
|
||||
SERVER *
|
||||
|
||||
@ -204,7 +204,7 @@ void gw_sha1_2_str(const uint8_t *in, int in_len, const uint8_t *in2, int in2_le
|
||||
|
||||
|
||||
/**
|
||||
* @node Gets errno corresponding to latest socket error
|
||||
* node Gets errno corresponding to latest socket error
|
||||
*
|
||||
* Parameters:
|
||||
* @param fd - in, use
|
||||
|
||||
Reference in New Issue
Block a user