From 4a96cfc150f797745c054bd5516e80079bdf52a8 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sun, 1 Mar 2009 14:57:52 +0100 Subject: [PATCH] More source code documentation. --- fec.c | 7 ++++++- udp_send.c | 2 ++ vss.c | 3 ++- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/fec.c b/fec.c index 043a1f21..f3e68454 100644 --- 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 c17fc313..7585eaa9 100644 --- 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 f1f96167..b8c7463b 100644 --- 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 -- 2.39.5