X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv_common.c;h=2d6aa74a55063da799f35d1b9abbe07b33aa59b4;hp=2ea8a5992034419cf0375bae43851172c136b765;hb=4a55942a597fc7c828a30557e6621debe5c37481;hpb=e2eebf654cae2fc004cee516a0e165127c0214ca diff --git a/recv_common.c b/recv_common.c index 2ea8a599..2d6aa74a 100644 --- a/recv_common.c +++ b/recv_common.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2006-2013 Andre Noll + * Copyright (C) 2006-2014 Andre Noll * * Licensed under the GPL v2. For licencing details see COPYING. */ @@ -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) {