Proxmox-Port/libqb
1
0
Fork 0
mirror of https://salsa.debian.org/ha-team/libqb synced 2025-12-30 18:22:35 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: enhance qb_log_ctl* description + fix doxygen warning

Browse Source
This commit is contained in:
Jan Pokorný 2016-03-14 15:41:29 +01:00
parent 0e8c01a027
commit cef7cab1eb
No known key found for this signature in database
GPG Key ID: 61BBB23A9E8F8DE2
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/qb/qblog.h
View File

@ -522,8 +522,12 @@ void qb_log_callsites_dump(void);
* Main logging control function.
*
* @param target QB_LOG_SYSLOG, QB_LOG_STDERR or result from qb_log_file_open()
* @param conf_type what to configure
* @param arg the new value
* @param conf_type configuration directive ("what to configure") that accepts
* <tt>int32_t</tt> argument determining the new value unless ignored
* for particular directive altogether
* (incompatible directives: QB_LOG_CONF_IDENT)
* @param arg the new value for a state-changing configuration directive,
* ignored otherwise
* @see qb_log_conf
*
* @retval -errno on error
@ -540,8 +544,15 @@ typedef union {
/**
* Extension of main logging control function accepting also strings.
*
* @param arg for QB_LOG_CONF_IDENT, 's' member as new identifier to openlog(),
* for all original qb_log_ctl-compatible configuration directives,
* @param target QB_LOG_SYSLOG, QB_LOG_STDERR or result from qb_log_file_open()
* @param conf_type configuration directive ("what to configure") that accepts
* either <tt>int32_t</tt> or a null-terminated string argument
* determining the new value unless ignored for particular directive
* (compatible directives: those valid for qb_log_ctl
* + QB_LOG_CONF_IDENT)
* @param arg the new value for a state-changing configuration directive,
* ignored otherwise; for QB_LOG_CONF_IDENT, 's' member as new
* identifier to openlog(), for all qb_log_ctl-compatible ones,
* 'i32' member is assumed (although a preferred way is to use
* that original function directly as it allows for more type safety)
* @see qb_log_ctl