From 4a55942a597fc7c828a30557e6621debe5c37481 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Wed, 8 Jan 2014 06:00:36 +0000 Subject: [PATCH] recv_common.c: Improve documentation of check_receiver_arg(). Drop meaningless "and further are present", and note that the "real" type of the returned pointer depends on the receiver. --- recv_common.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/recv_common.c b/recv_common.c index 58d4ca2b..2d6aa74a 100644 --- a/recv_common.c +++ b/recv_common.c @@ -50,19 +50,19 @@ static void *parse_receiver_args(int receiver_num, char *options) } /** - * check if given string is a valid command line for any receiver + * Check if the given string is a valid receiver specifier. * * \param \ra string of the form receiver_name:options * \param receiver_num contains the number of the receiver upon success * * This function checks whether \a ra starts with the name of a supported * paraslash receiver, optinally followed by a colon and any options for that - * receiver. If a valid receiver name was found and further are present, the - * remaining part of \a ra is passed to that receiver's config parser. + * receiver. If a valid receiver name was found the remaining part of \a ra is + * passed to the receiver's config parser. * - * \return On success, a pointer to the gengetopt args info struct is returned - * and \a receiver_num contains the number of the receiver. Otherwise this function - * returns \p NULL. + * \return On success, a pointer to the receiver-specific gengetopt args info + * struct is returned and \a receiver_num contains the number of the receiver. + * On errors, the function returns \p NULL. */ void *check_receiver_arg(char *ra, int *receiver_num) { -- 2.39.5