Use boolean to enable all the options instead of string compares.

[thirdparty/sarg.git] / documentation / getconf.txt

diff --git a/documentation/getconf.txt b/documentation/getconf.txt
index 795b7742c2f8af2b7d116824cc316217182eca4f..1298bc2e5bbfc0bdc4530aa60edf916d635b11c8 100644 (file)
--- a/documentation/getconf.txt
+++ b/documentation/getconf.txt
@@ -17,7 +17,7 @@ Tell if the buffer contains a line defining the given parameter.
 
 
 /*! \fn static int getparam_string(const char *param,char *buf,char *value,int value_size)
-Extract a string value from a line if it it the right parameter.
+Extract a string value from a line if it is the right parameter.
 
 \param param The name of the parameter to find.
 \param buf The string read from the input file.
@@ -33,7 +33,7 @@ Extract a string value from a line if it it the right parameter.
 
 
 /*! \fn static int getparam_quoted(const char *param,char *buf,char *value,int value_size)
-Extract a quoted string value from a line if it it the right parameter.
+Extract a quoted string value from a line if it is the right parameter.
 
 \param param The name of the parameter to find.
 \param buf The string read from the input file.
@@ -49,7 +49,22 @@ Extract a quoted string value from a line if it it the right parameter.
 
 
 /*! \fn static int getparam_int(const char *param,char *buf,int *value)
-Extract an integer value from a line if it it the right parameter.
+Extract an integer value from a line if it is the right parameter.
+
+\param param The name of the parameter to find.
+\param buf The string read from the input file.
+\param value The variable to store the value.
+
+\retval 1 Parameter match.
+\retval 0 The line is not for that parameter.
+*/
+
+
+
+
+
+/*! \fn static int getparam_bool(const char *param,char *buf,int *value)
+Extract a boolean flag from a line if it is the right parameter.
 
 \param param The name of the parameter to find.
 \param buf The string read from the input file.