--- embedaddon/confuse/doc/man/man3/cfg_opt_t.3 2017/01/24 14:48:55 1.1.1.1 +++ embedaddon/confuse/doc/man/man3/cfg_opt_t.3 2021/03/17 00:49:17 1.1.1.2 @@ -1,78 +1,84 @@ -.TH "cfg_opt_t" 3 "21 Feb 2010" "Version 2.7" "confuse" \" -*- nroff -*- +.TH "cfg_opt_t" 3 "Thu Jun 25 2020" "Version 3.3" "confuse" \" -*- nroff -*- .ad l .nh .SH NAME -cfg_opt_t \- Data structure holding information about an option. +cfg_opt_t \- Data structure holding information about an option\&. -.PP .SH SYNOPSIS .br .PP -\fC#include \fP .PP +\fC#include \fP .SS "Data Fields" .in +1c .ti -1c -.RI "char * \fBname\fP" +.RI "const char * \fBname\fP" .br -.RI "\fIThe name of the option. \fP" +.RI "The name of the option\&. " .ti -1c +.RI "char * \fBcomment\fP" +.br +.RI "Optional comment/annotation\&. " +.ti -1c .RI "\fBcfg_type_t\fP \fBtype\fP" .br -.RI "\fIType of option. \fP" +.RI "Type of option\&. " .ti -1c .RI "unsigned int \fBnvalues\fP" .br -.RI "\fINumber of values parsed. \fP" +.RI "Number of values parsed\&. " .ti -1c .RI "\fBcfg_value_t\fP ** \fBvalues\fP" .br -.RI "\fIArray of found values. \fP" +.RI "Array of found values\&. " .ti -1c .RI "cfg_flag_t \fBflags\fP" .br -.RI "\fIFlags. \fP" +.RI "Flags\&. " .ti -1c .RI "\fBcfg_opt_t\fP * \fBsubopts\fP" .br -.RI "\fISuboptions (only applies to sections). \fP" +.RI "Suboptions (only applies to sections) " .ti -1c .RI "\fBcfg_defvalue_t\fP \fBdef\fP" .br -.RI "\fIDefault value. \fP" +.RI "Default value\&. " .ti -1c .RI "\fBcfg_func_t\fP \fBfunc\fP" .br -.RI "\fIFunction callback for CFGT_FUNC options. \fP" +.RI "Function callback for CFGT_FUNC options\&. " .ti -1c -.RI "void * \fBsimple_value\fP" +.RI "\fBcfg_simple_t\fP \fBsimple_value\fP" .br -.RI "\fIPointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers). \fP" +.RI "Pointer to user-specified variable to store simple values (created with the CFG_SIMPLE_* initializers) " .ti -1c .RI "\fBcfg_callback_t\fP \fBparsecb\fP" .br -.RI "\fIValue parsing callback function. \fP" +.RI "Value parsing callback function\&. " .ti -1c .RI "\fBcfg_validate_callback_t\fP \fBvalidcb\fP" .br -.RI "\fIValue validating callback function. \fP" +.RI "Value validating parsing callback function\&. " .ti -1c +.RI "\fBcfg_validate_callback2_t\fP \fBvalidcb2\fP" +.br +.RI "Value validating set callback function\&. " +.ti -1c .RI "\fBcfg_print_func_t\fP \fBpf\fP" .br -.RI "\fIprint callback function \fP" +.RI "print callback function " .in -1c .SH "Detailed Description" .PP -Data structure holding information about an option. +Data structure holding information about an option\&. -The value(s) are stored as an array of fundamental values (strings, numbers, etc). +The value(s) are stored as an array of fundamental values (strings, numbers, etc)\&. .PP -\fBExamples: \fP +\fBExamples\fP .in +1c -.PP -\fBftpconf.c\fP, \fBreread.c\fP, and \fBsimple.c\fP. +\fBftpconf\&.c\fP, \fBreread\&.c\fP, and \fBsimple\&.c\fP\&. .SH "Author" .PP -Generated automatically by Doxygen for confuse from the source code. +Generated automatically by Doxygen for confuse from the source code\&.