From: Andre Noll Date: Fri, 28 Jul 2017 21:13:52 +0000 (+0200) Subject: Improve documentation of signal_init_or_die(). X-Git-Tag: v0.6.1~42 X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=a6fc2bd6ed685c4e3ab3006b808cfbd383ea97c9;ds=inline Improve documentation of signal_init_or_die(). Prefix the reference to para_install_sighandler() with \ref to make sure doxygen warns if the reference becomes stale, and fix the man section of exit(): it is not a system call (but _exit() is). --- diff --git a/signal.c b/signal.c index 5d6e6e45..9153349f 100644 --- a/signal.c +++ b/signal.c @@ -25,7 +25,7 @@ static int signal_pipe[2]; * This function creates a pipe, the signal pipe, to deliver pending * signals to the application (Bernstein's trick). It should be called * during the application's startup part, followed by subsequent calls - * to para_install_sighandler() for each signal that should be caught. + * to \ref para_install_sighandler() for each signal that should be caught. * * A generic signal handler is used for all signals simultaneously. When a * signal arrives, the signal handler writes the number of the signal received @@ -33,7 +33,7 @@ static int signal_pipe[2]; * by checking if the file descriptor of the other end of the signal pipe is * ready for reading, see select(2). * - * \return This function either succeeds or calls exit(2) to terminate the + * \return This function either succeeds or calls exit(3) to terminate the * current process. On success, a signal task structure is returned. */ struct signal_task *signal_init_or_die(void)