Trivial typo fixes and cosmetic cleanups.

[paraslash.git] / send_common.c

diff --git a/send_common.c b/send_common.c
index 448ddfec0f83692f0fa144487418df3a9b02fad7..b81600737e441bef40837f23f7e1d877b297b62a 100644 (file)
--- a/send_common.c
+++ b/send_common.c
@@ -440,6 +440,21 @@ out:
        return ret;
 }
 
+/**
+ * Parse a FEC URL string.
+ *
+ * \param arg the URL string to parse.
+ * \param scd The structure containing host, port and the FEC parameters.
+ *
+ * \return Standard.
+ *
+ * A FEC URL consists of an ordinary URL string according to RFC 3986,
+ * optionally followed by a slash and the three FEC parameters slice_size,
+ * data_slices_per_group and slices_per_group. The three FEC parameters are
+ * separated by colons.
+ *
+ * \sa \ref parse_url().
+ */
 int parse_fec_url(const char *arg, struct sender_command_data *scd)
 {
        int ret;