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

diff --git a/recv_common.c b/recv_common.c
index 0393d764..8f8f6369 100644
--- a/recv_common.c
+++ b/recv_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 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
@@ -60,6 +60,21 @@ static void *parse_receiver_args(int receiver_num, char *options)
 	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;