From: Andre Noll <maan@systemlinux.org>
Date: Sat, 9 Feb 2008 18:42:05 +0000 (+0100)
Subject: user_list.c: Minor documentation impreovements.
X-Git-Tag: v0.3.1~31
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=cd8bb5a2d51179a31842a2cd7012cad28deea78d

user_list.c: Minor documentation impreovements.
---

diff --git a/user_list.c b/user_list.c
index eebdfd72..e13d8bb7 100644
--- a/user_list.c
+++ b/user_list.c
@@ -4,7 +4,7 @@
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file user_list.c user handling for para_server */
+/** \file user_list.c User handling for para_server. */
 
 #include <sys/types.h>
 #include <dirent.h>
@@ -85,12 +85,12 @@ err:
 }
 
 /**
- * initialize the list of users allowed to connecto to para_server
+ * Initialize the list of users allowed to connect to to para_server.
  *
- * \param user_list_file the file containing access information
+ * \param user_list_file The file containing access information.
  *
- * If this function is called a second time, the contents of the
- * previous call are discarded.
+ * If this function is called for the second time, the contents of the
+ * previous call are discarded, i.e. the user list is reloaded.
  */
 void init_user_list(char *user_list_file)
 {
@@ -111,12 +111,12 @@ void init_user_list(char *user_list_file)
 }
 
 /**
- * lookup user in user_list.
+ * Lookup a user in the user list.
  *
- * \param name of the user
+ * \param The name of the user.
  *
- * \return a pointer to the corresponding user struct if the user was found,
- *  \p NULL otherwise.
+ * \return A pointer to the corresponding user struct if the user was found, \p
+ * NULL otherwise.
  */
 struct user *lookup_user(const char *name)
 {