hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen compliance corrections

Browse Source
This commit is contained in:
vraatikka
2013-12-01 21:47:38 +02:00
parent 4a006dd707
commit cbbf3239a5
1 changed files with 12 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
server/core/gateway.c
View File

@ -170,14 +170,8 @@ sigint_handler (int i)
* @node Wraps sigaction calls * @node Wraps sigaction calls
* *
* Parameters: * Parameters:
* @param sig - <usage> * @param sig Signal to set
* <description> * @param void Handler function for signal *
*
* @param void - <usage>
* <description>
*
* @param handler - <usage>
* <description>
* *
* @return 0 in success, 1 otherwise * @return 0 in success, 1 otherwise
* *
@ -280,6 +274,7 @@ static bool file_write_footer(
return succp; return succp;
} }
static bool file_write_header( static bool file_write_header(
FILE* outfile) FILE* outfile)
{ {
@ -441,6 +436,7 @@ return_succp:
return succp; return succp;
} }
static bool resolve_maxscale_homedir( static bool resolve_maxscale_homedir(
char** p_home_dir) char** p_home_dir)
{ {
@ -581,21 +577,15 @@ return_succp:
/** /**
* @node Provides error printing for non-formatted error strings. * @node Provides error printing for non-formatted error strings.
* *
* Parameters: * @param do_log Specifies whether printing to log is enabled
* @param do_log - in, use
* is printing to log enabled
* *
* @param do_stderr - in, use * @param do_stderr Specifies whether printing to stderr is enabled
* is printing to stderr enabled
* *
* @param logstr - in, use * @param logstr String to be printed to log
* string to be printed to log
* *
* @param fprstr - in, use * @param fprstr String to be printed to stderr
* string to be printed to stderr
* *
* @param eno - in, use * @param eno Errno, if it is set, zero, otherwise
* errno, if it is set, zero, otherwise
* *
* @return void * @return void
* *
@ -867,8 +857,9 @@ static void usage(void)
* This is not obvious solution because stderr is often directed to somewhere, * This is not obvious solution because stderr is often directed to somewhere,
* but currently this is the case. * but currently this is the case.
* *
* MaxScale.cnf - the configuration file is located in <maxscale home>/etc * The configuration file is by default <maxscale home>/etc/MaxScale.cnf
* Note that configuration file name may be specified with command-line argument. * The name of configuration file and its location can be specified by
* command-line argument.
* *
* <maxscale home> is resolved in the following order: * <maxscale home> is resolved in the following order:
* 1. from '-c <dir>' command-line argument * 1. from '-c <dir>' command-line argument