From cd8bb5a2d51179a31842a2cd7012cad28deea78d Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 9 Feb 2008 19:42:05 +0100 Subject: [PATCH] user_list.c: Minor documentation impreovements. --- user_list.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) 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 #include @@ -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) { -- 2.39.5