#1587 Doc build for ding-libs produces a lot of warnings
Closed: Fixed None Opened 6 years ago by dpal.

I noticed that ding-libs doc build complains about

a. Wrong options
{{{
Warning: ignoring unsupported tag FORCE_LOCAL_INCLUDES =' at line 403, file basicobjects.cfg.doxy Warning: ignoring unsupported tagHTML_FOOTER_DESCRIPTION=' at line 785, file basicobjects.cfg.doxy
Warning: ignoring unsupported tag GENERATE_ECLIPSEHELP =' at line 967, file basicobjects.cfg.doxy Warning: ignoring unsupported tagECLIPSE_DOC_ID =' at line 973, file basicobjects.cfg.doxy
Warning: ignoring unsupported tag SERVER_BASED_SEARCH =' at line 1026, file basicobjects.cfg.doxy Warning: argumentNOGENERATEMAN' for option SORT_MEMBER_DOCS is not a valid boolean value
}}}
b. Mismatch in the names of the arguments in the function calls and descriptions of those arguments.
{{{
/home/dpal/Code/ding-libs/ini/ini_configobj.h:554: Warning: argument 'errors' of command @param is not found in the argument list of ini_config_print_errors(FILE file, char error_list)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:554: Warning: The following parameters of ini_config_print_errors(FILE *file, char
error_list) are not documented:
parameter 'error_list'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1382: Warning: argument 'item' of command @param is not found in the argument list of ini_get_bin_config_value(struct value_obj
vo, int length, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1382: Warning: The following parameters of ini_get_bin_config_value(struct value_obj vo, int length, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1295: Warning: argument 'item' of command @param is not found in the argument list of ini_get_bool_config_value(struct value_obj
vo, unsigned char def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1295: Warning: The following parameters of ini_get_bool_config_value(struct value_obj
vo, unsigned char def, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1357: Warning: argument 'item' of command @param is not found in the argument list of ini_get_const_string_config_value(struct value_obj
vo, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1357: Warning: The following parameters of ini_get_const_string_config_value(struct value_obj
vo, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1609: Warning: argument 'item' of command @param is not found in the argument list of ini_get_double_config_array(struct value_obj
vo, int size, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1609: Warning: The following parameters of ini_get_double_config_array(struct value_obj vo, int size, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1252: Warning: argument 'item' of command @param is not found in the argument list of ini_get_double_config_value(struct value_obj
vo, int strict, double def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1252: Warning: The following parameters of ini_get_double_config_value(struct value_obj
vo, int strict, double def, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1162: Warning: argument 'item' of command @param is not found in the argument list of ini_get_int64_config_value(struct value_obj
vo, int strict, int64_t def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1162: Warning: The following parameters of ini_get_int64_config_value(struct value_obj
vo, int strict, int64_t def, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1563: Warning: argument 'item' of command @param is not found in the argument list of ini_get_long_config_array(struct value_obj
vo, int size, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1563: Warning: The following parameters of ini_get_long_config_array(struct value_obj vo, int size, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1504: Warning: argument 'item' of command @param is not found in the argument list of ini_get_raw_string_config_array(struct value_obj
vo, const char sep, int size, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1504: Warning: The following parameters of ini_get_raw_string_config_array(struct value_obj
vo, const char sep, int size, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1445: Warning: argument 'item' of command @param is not found in the argument list of ini_get_string_config_array(struct value_obj
vo, const char sep, int size, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1445: Warning: The following parameters of ini_get_string_config_array(struct value_obj
vo, const char sep, int size, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1332: Warning: argument 'item' of command @param is not found in the argument list of ini_get_string_config_value(struct value_obj
vo, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1332: Warning: The following parameters of ini_get_string_config_value(struct value_obj
vo, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1117: Warning: argument 'item' of command @param is not found in the argument list of ini_get_uint32_config_value(struct value_obj
vo, int strict, uint32_t def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1117: Warning: The following parameters of ini_get_uint32_config_value(struct value_obj
vo, int strict, uint32_t def, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1207: Warning: argument 'item' of command @param is not found in the argument list of ini_get_uint64_config_value(struct value_obj
vo, int strict, uint64_t def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:1207: Warning: The following parameters of ini_get_uint64_config_value(struct value_obj
vo, int strict, uint64_t def, int error) are not documented:
parameter 'vo'
/home/dpal/Code/ding-libs/ini/ini_configobj.h:933: Warning: argument 'item' of command @param is not found in the argument list of ini_get_unsigned_config_value(struct value_obj
vo, int strict, unsigned def, int error)
/home/dpal/Code/ding-libs/ini/ini_configobj.h:933: Warning: The following parameters of ini_get_unsigned_config_value(struct value_obj
vo, int strict, unsigned def, int *error) are not documented:
parameter 'vo'
}}}


Fields changed

patch: 0 => 1

Fields changed

patch: 0 => 1

Fields changed

patch: 0 => 1

Fields changed

rhbz: => 0

Fields changed

rhbz: => 0

Fields changed

rhbz: => 0

Fields changed

design_review: => 0
resolution: => fixed
status: new => closed

Fields changed

design_review: => 0
resolution: => fixed
status: new => closed

Fields changed

design_review: => 0
resolution: => fixed
status: new => closed

Metadata Update from @dpal:
- Issue set to the milestone: Tools 1.0

2 years ago

Login to comment on this ticket.

Metadata