More source code documentation.
authorAndre Noll <maan@systemlinux.org>
Sun, 1 Mar 2009 13:57:52 +0000 (14:57 +0100)
committerAndre Noll <maan@systemlinux.org>
Sun, 1 Mar 2009 13:57:52 +0000 (14:57 +0100)
fec.c
udp_send.c
vss.c

diff --git a/fec.c b/fec.c
index 043a1f2..f3e6845 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;
 };
 
index c17fc31..7585eaa 100644 (file)
@@ -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 f1f9616..b8c7463 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