From 1368b794c3079c2c641a406f004e207bdbc746a0 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Sun, 18 Oct 2009 04:22:26 +0200 Subject: doxygen updates --- libdaemon/dexec.h | 16 ++++++++++++---- libdaemon/dfork.h | 39 ++++++++++++++++++++++++++++++--------- libdaemon/dlog.h | 15 +++++++++++---- libdaemon/dpid.h | 6 +++++- 4 files changed, 58 insertions(+), 18 deletions(-) diff --git a/libdaemon/dexec.h b/libdaemon/dexec.h index 1f7f7e8..9b34240 100644 --- a/libdaemon/dexec.h +++ b/libdaemon/dexec.h @@ -33,13 +33,15 @@ extern "C" { * STDERR redirected to syslog */ -/** This variable is defined to 1 iff daemon_exec() is supported.*/ +/** This variable is defined to 1 iff daemon_exec() is supported. + * @since 0.4 + * @see daemon_exec() */ #define DAEMON_EXEC_AVAILABLE 1 #if defined(__GNUC__) && ! defined(DAEMON_GCC_SENTINEL) -/** A macro for making use of GCCs printf compilation warnings */ #define DAEMON_GCC_SENTINEL __attribute__ ((sentinel)) #else +/** A macro for making use of GCCs printf compilation warnings */ #define DAEMON_GCC_SENTINEL #endif @@ -55,13 +57,19 @@ extern "C" { * @param prog The path to the executable * @param ... The arguments to be passed to the program, followed by a (char *) NULL * @return Nonzero on failure, zero on success + * @since 0.4 + * @see DAEMON_EXEC_AVAILABLE */ int daemon_exec(const char *dir, int *ret, const char *prog, ...) DAEMON_GCC_SENTINEL; -/** This variable is defined to 1 iff daemon_execv() is supported.*/ +/** This variable is defined to 1 iff daemon_execv() is supported. + * @since 0.11 + * @see daemon_execv() */ #define DAEMON_EXECV_AVAILABLE 1 -/** The same as daemon_exec, but without variadic arguments */ +/** The same as daemon_exec, but without variadic arguments + * @since 0.11 + * @see DAEMON_EXECV_AVAILABLE */ int daemon_execv(const char *dir, int *ret, const char *prog, va_list ap); #ifdef __cplusplus diff --git a/libdaemon/dfork.h b/libdaemon/dfork.h index 566844f..4a9c43e 100644 --- a/libdaemon/dfork.h +++ b/libdaemon/dfork.h @@ -99,37 +99,58 @@ int daemon_retval_wait(int timeout); */ int daemon_retval_send(int s); -/** This variable is defined to 1 iff daemon_close_all() and daemon_close_allv() are supported.*/ +/** This variable is defined to 1 iff daemon_close_all() and + * daemon_close_allv() are supported. + * @since 0.11 + * @see daemon_close_all(), daemon_close_allv() */ #define DAEMON_CLOSE_ALL_AVAILABLE 1 /** Close all file descriptors except those passed. List needs to be - * terminated by -1. FDs 0, 1, 2 will be kept open anyway. */ + * terminated by -1. FDs 0, 1, 2 will be kept open anyway. + * @since 0.11 + * @see DAEMON_CLOSE_ALL_AVAILABLE */ int daemon_close_all(int except_fd, ...); /** Same as daemon_close_all but takes an array of fds, terminated by - * -1 */ + * -1 + * @since 0.11 + * @see DAEMON_CLOSE_ALL_AVAILABLE */ int daemon_close_allv(const int except_fds[]); -/** This variable is defined to 1 iff daemon_unblock_sigs() and daemon_unblock_sigsv() are supported.*/ +/** This variable is defined to 1 iff daemon_unblock_sigs() and + * daemon_unblock_sigsv() are supported. + * @since 0.13 + * @see daemon_unblock_sigs(), daemon_unblock_sigsv()*/ #define DAEMON_UNBLOCK_SIGS_AVAILABLE 1 /** Unblock all signals except those passed. List needs to be - * terminated by -1. */ + * terminated by -1. + * @since 0.13 + * @see DAEMON_UNBLOCK_SIGS_AVAILABLE */ int daemon_unblock_sigs(int except, ...); /** Same as daemon_unblock_sigs() but takes an array of signals, - * terminated by -1 */ + * terminated by -1 + * @since 0.13 + * @see DAEMON_UNBLOCK_SIGS_AVAILABLE */ int daemon_unblock_sigsv(const int except[]); -/** This variable is defined to 1 iff daemon_reset_sigs() and daemon_reset_sigsv() are supported.*/ +/** This variable is defined to 1 iff daemon_reset_sigs() and + * daemon_reset_sigsv() are supported. + * @since 0.13 + * @see daemon_reset_sigs(), daemon_reset_sigsv() */ #define DAEMON_RESET_SIGS_AVAILABLE 1 /** Reset all signal handlers except those passed. List needs to be - * terminated by -1. */ + * terminated by -1. + * @since 0.13 + * @see DAEMON_RESET_SIGS_AVAILABLE */ int daemon_reset_sigs(int except, ...); /** Same as daemon_reset_sigs() but takes an array of signals, - * terminated by -1 */ + * terminated by -1 + * @since 0.13 + * @see DAEMON_RESET_SIGS_AVAILABLE */ int daemon_reset_sigsv(const int except[]); #ifdef __cplusplus diff --git a/libdaemon/dlog.h b/libdaemon/dlog.h index 9755df6..0803d36 100644 --- a/libdaemon/dlog.h +++ b/libdaemon/dlog.h @@ -44,7 +44,8 @@ enum daemon_log_flags { the daemon process. */ }; -/** This variable is used to specify the log target(s) to use. Defaults to DAEMON_LOG_STDERR|DAEMON_LOG_AUTO */ +/** This variable is used to specify the log target(s) to + * use. Defaults to DAEMON_LOG_STDERR|DAEMON_LOG_AUTO */ extern enum daemon_log_flags daemon_log_use; /** Specifies the syslog identification, use daemon_ident_from_argv0() @@ -52,9 +53,9 @@ extern enum daemon_log_flags daemon_log_use; extern const char* daemon_log_ident; #if defined(__GNUC__) && ! defined(DAEMON_GCC_PRINTF_ATTR) -/** A macro for making use of GCCs printf compilation warnings */ #define DAEMON_GCC_PRINTF_ATTR(a,b) __attribute__ ((format (printf, a, b))) #else +/** A macro for making use of GCCs printf compilation warnings */ #define DAEMON_GCC_PRINTF_ATTR(a,b) #endif @@ -64,7 +65,10 @@ extern const char* daemon_log_ident; */ void daemon_log(int prio, const char* t, ...) DAEMON_GCC_PRINTF_ATTR(2,3); -/** This variable is defined to 1 iff daemon_logv() is supported.*/ +/** This variable is defined to 1 iff daemon_logv() is supported. + * @since 0.11 + * @see daemon_logv() + */ #define DAEMON_LOGV_AVAILABLE 1 /** Same as daemon_log(), but without variadic arguments @@ -84,7 +88,7 @@ char *daemon_ident_from_argv0(char *argv0); /** * @brief Setter for the verbosity level of standard output. * - * @param verbose_level Minimum priority level for messages to output + * @param verbosity_prio Minimum priority level for messages to output * on standard output/error * * Allows to decide which messages to output on standard output/error @@ -92,6 +96,9 @@ char *daemon_ident_from_argv0(char *argv0); * not influence that. * * The default value is LOG_WARNING. + * + * @since 0.14 + * @see DAEMON_SET_VERBOSITY_AVAILABLE */ void daemon_set_verbosity(int verbosity_prio); diff --git a/libdaemon/dpid.h b/libdaemon/dpid.h index 01d87f3..ee49319 100644 --- a/libdaemon/dpid.h +++ b/libdaemon/dpid.h @@ -76,7 +76,9 @@ pid_t daemon_pid_file_is_running(void); */ int daemon_pid_file_kill(int s); -/** This variable is defined to 1 iff daemon_pid_file_kill_wait() is supported.*/ +/** This variable is defined to 1 iff daemon_pid_file_kill_wait() is supported. + * @since 0.3 + * @see daemon_pid_file_kill_wait() */ #define DAEMON_PID_FILE_KILL_WAIT_AVAILABLE 1 /** Similar to daemon_pid_file_kill() but waits until the process @@ -87,6 +89,8 @@ int daemon_pid_file_kill(int s); * @param s The signal to send * @param m Seconds to wait at maximum * @return zero on success, nonzero on failure (timeout condition is considered a failure) + * @since 0.3 + * @see DAEMON_PID_FILE_KILL_WAIT_AVAILABLE */ int daemon_pid_file_kill_wait(int s, int m); -- cgit