Trivial documentation cleanups.
[paraslash.git] / daemon.c
index 5d4cf69..a2fa1ca 100644 (file)
--- a/daemon.c
+++ b/daemon.c
@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 1997-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file daemon.c some helpers for programs that detach from the console */
+/** \file daemon.c Some helpers for programs that detach from the console. */
 #include "para.h"
 #include "daemon.h"
 #include <pwd.h>
 #include "string.h"
 
 /**
- * do the usual stuff to become a daemon
+ * Do the usual stuff to become a daemon.
  *
  * Fork, become session leader, dup fd 0, 1, 2 to /dev/null.
  *
- * \sa fork(2), setsid(2), dup(2)
+ * \sa fork(2), setsid(2), dup(2).
  */
 void daemon_init(void)
 {
@@ -48,11 +48,11 @@ void daemon_init(void)
 }
 
 /**
- * fopen() a file in append mode
+ * fopen() a file in append mode.
  *
- * \param logfile_name the name of the file to open
+ * \param logfile_name The name of the file to open.
  *
- * Either calls exit() or returns a valid file handle.
+ * \return Either calls exit() or returns a valid file handle.
  */
 FILE *open_log(const char *logfile_name)
 {
@@ -70,11 +70,11 @@ FILE *open_log(const char *logfile_name)
 }
 
 /**
- * close the log file of the daemon
+ * Close the log file of the daemon.
  *
- * \param logfile the log file handle
+ * \param logfile The log file handle.
  *
- * It's OK to call this with logfile == NULL
+ * It's OK to call this with logfile == \p NULL.
  */
 void close_log(FILE* logfile)
 {
@@ -85,7 +85,7 @@ void close_log(FILE* logfile)
 }
 
 /**
- * log the startup message containing the paraslash version
+ * Log the startup message containing the paraslash version.
  */
 void log_welcome(const char *whoami, int loglevel)
 {
@@ -95,10 +95,10 @@ void log_welcome(const char *whoami, int loglevel)
 }
 
 /**
- * give up superuser privileges
+ * Give up superuser privileges.
  *
- * \param username the user to switch to
- * \param groupname the group to switch to
+ * \param username The user to switch to.
+ * \param groupname The group to switch to.
  *
  * This function returns immediately if not invoked with EUID zero. Otherwise,
  * it tries to obtain the GID of \a groupname and the UID of \a username.  On
@@ -144,16 +144,18 @@ void para_drop_privileges(const char *username, const char *groupname)
 }
 
 /**
- * set/get the server uptime
+ * Set/get the server uptime.
  *
- * \param set_or_get chose one of the two modes
+ * \param set_or_get Chose one of the two modes.
  *
  * This should be called at startup time with \a set_or_get equal to \p
  * UPTIME_SET which sets the uptime to zero.  Subsequent calls with \a
- * set_or_get equal to \p UPTIME_GET return the number of seconds ellapsed
- * since the last reset.
+ * set_or_get equal to \p UPTIME_GET return the uptime.
+
+ * \return Zero if called with \a set_or_get equal to \p UPTIME_SET, the number
+ * of seconds ellapsed since the last reset otherwise.
  *
- * \sa time(2), difftime(3)
+ * \sa time(2), difftime(3).
  */
 time_t server_uptime(enum uptime set_or_get)
 {
@@ -171,11 +173,11 @@ time_t server_uptime(enum uptime set_or_get)
 }
 
 /**
- * construct string containing uptime
+ * Construct string containing uptime.
  *
- * The format of the returned string is "days:hours:minutes"
+ * \return A dynamically allocated string of the form "days:hours:minutes".
  *
- * \sa server_uptime
+ * \sa server_uptime.
  */
 __malloc char *uptime_str(void)
 {