More source code documentation.

diff --git a/fec.c b/fec.c
index 043a1f21869617869d2c6d0573bf71777611e2a3..f3e68454941e702ff7cb9ca78ca9a3b749998086 100644 (file)
--- a/fec.c
+++ b/fec.c
@@ -394,8 +394,13 @@ static void init_fec(void)
        fec_initialized = 1;
 }
 
+/** Internal FEC parameters. */
 struct fec_parms {
-       int k, n; /* parameters of the code */
+       /** Number of data slices. */
+       int k;
+       /** Number of slices (including redundant slices). */
+       int n;
+       /** The encoding matrix, computed by init_fec(). */
        unsigned char *enc_matrix;
 };
 

diff --git a/udp_send.c b/udp_send.c
index c17fc313ef49589bf42f55fc168c1aeb63ac216a..7585eaa962ecb4577ed16e41c88235ed6ccec60a 100644 (file)
--- a/udp_send.c
+++ b/udp_send.c
@@ -40,7 +40,9 @@ struct udp_target {
        int fd;
        /** The list of queued chunks for this fd. */
        struct chunk_queue *cq;
+       /** The opaque structure returned by vss_add_fec_client(). */
        struct fec_client *fc;
+       /** The FEC parameters for this target. */
        struct fec_client_parms fcp;
 };
 

diff --git a/vss.c b/vss.c
index f1f9616768d21fdc2b682dabd5c8872b54eee2aa..b8c7463b68345ccea84a15dfd9d4625adf7d3ac4 100644 (file)
--- a/vss.c
+++ b/vss.c
@@ -143,7 +143,7 @@ struct fec_client {
        struct fec_client_parms *fcp;
        /** Used by the core FEC code. */
        struct fec_parms *parms;
-       /** The position of this client in \a \ref fec_client_list. */
+       /** The position of this client in the fec client list. */
        struct list_head node;
        /** When the first slice for this client was sent. */
        struct timeval stream_start;
@@ -266,6 +266,7 @@ static void write_fec_header(struct fec_client *fc)
 /**
  * Return a buffer that marks the end of the stream.
  *
+ * \param buf Result pointer.
  * \return The length of the eof buffer.
  *
  * This is used for (multicast) udp streaming where closing the socket on the