Fix documentation of check_receiver_arg().
authorAndre Noll <maan@tuebingen.mpg.de>
Wed, 30 Sep 2015 01:09:24 +0000 (01:09 +0000)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 10 Jan 2016 11:58:52 +0000 (12:58 +0100)
Receiver name and options are NOT separated by a colon. Also, all three
receivers (http, udp, dccp) are always supported, so it's pointless
to talk about supported paraslash receivers. This patch simplifies
the comment accordingly.

recv_common.c

index aa2823c..59630df 100644 (file)
@@ -55,10 +55,10 @@ static void *parse_receiver_args(int receiver_num, char *options)
  * \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, optionally followed by a colon and any options for that
- * receiver. If a valid receiver name was found the remaining part of \a ra is
- * passed to the receiver's config parser.
+ * This function checks whether \a ra starts with the name of a receiver,
+ * optionally followed by options for that 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 receiver-specific gengetopt args info
  * struct is returned and \a receiver_num contains the number of the receiver.