summary |
shortlog |
log |
commit | commitdiff |
tree
raw |
patch |
inline | side by side (from parent 1:
25775b4)
Drop meaningless "and further are present", and note that the "real"
type of the returned pointer depends on the receiver.
- * 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
*
* \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)
{
*/
void *check_receiver_arg(char *ra, int *receiver_num)
{