Merge branch 'refs/heads/t/markdown'
[paraslash.git] / fec.h
diff --git a/fec.h b/fec.h
index 241cf9a..d09b035 100644 (file)
--- a/fec.h
+++ b/fec.h
@@ -1,5 +1,6 @@
+/** \file fec.h Exported symbols from fec.c. */
+
 /*
 /*
- * fec.c -- forward error correction based on Vandermonde matrices
  * 980614
  * (C) 1997-98 Luigi Rizzo (luigi@iet.unipi.it)
  *
  * 980614
  * (C) 1997-98 Luigi Rizzo (luigi@iet.unipi.it)
  *
  * OF SUCH DAMAGE.
  */
 
  * OF SUCH DAMAGE.
  */
 
-#define FEC_MAGIC 0xFECC0DEC
+/** Each FEC slice contains a FEC header of this size. */
 #define FEC_HEADER_SIZE 32
 #define FEC_HEADER_SIZE 32
+/** The FEC header starts with this magic value. */
+#define FEC_MAGIC 0xFECC0DEC
 
 struct fec_parms;
 
 
 struct fec_parms;
 
@@ -43,5 +46,3 @@ void fec_encode(struct fec_parms *parms, const unsigned char * const *src,
                unsigned char *dst, int idx, int sz);
 int fec_decode(struct fec_parms *parms, unsigned char **data, int *idx,
                int sz);
                unsigned char *dst, int idx, int sz);
 int fec_decode(struct fec_parms *parms, unsigned char **data, int *idx,
                int sz);
-
-