X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=recv_common.c;h=ea1bbc937a8c7a26bf8e319cd9194b50de693093;hp=0393d7641abbae85e9645e260417551d4e7fea8b;hb=9f021e58c181e2cd2e1e245fcd7b84f33ad50f9d;hpb=a87d4a87ac7418084eb78f0bcb3accff1388df3a

diff --git a/recv_common.c b/recv_common.c
index 0393d764..ea1bbc93 100644
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file recv_common.c common functions of para_recv and para_audiod */
@@ -51,15 +39,26 @@ static void *parse_receiver_args(int receiver_num, char *options)
 		argv[1] = NULL;
 	}
 	conf = r->parse_config(argc, argv);
-	if (!conf) {
-		for (i = 0; i < argc; i++)
-			free(argv[i]);
-		free(argv);
-		return NULL;
-	}
+	free(argv[0]);
+	free(argv);
 	return conf;
 }
 
+/**
+ * check if given string is a valid command line for any receiver
+ *
+ * \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.
+ *
+ * \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.
+ */
 void *check_receiver_arg(char *ra, int *receiver_num)
 {
 	int j;