]> git.rkrishnan.org Git - tahoe-lafs/zfec.git/blobdiff - zfec/zfec/fec.h
docs: update docs and metadata
[tahoe-lafs/zfec.git] / zfec / zfec / fec.h
index e67778d11c4820617d211f4a33ed289f2f1e2ed0..249fe666f495f647892b73d234d769f5e77e4c77 100644 (file)
@@ -1,7 +1,7 @@
 /**
  * zfec -- fast forward error correction library with Python interface
  *
- * See README.txt for documentation.
+ * See README.rst for documentation.
  */
 
 #include <stddef.h>
@@ -10,7 +10,7 @@ typedef unsigned char gf;
 
 typedef struct {
   unsigned long magic;
-  unsigned k, n;                     /* parameters of the code */
+  unsigned short k, n;                     /* parameters of the code */
   gf* enc_matrix;
 } fec_t;
 
@@ -24,7 +24,7 @@ typedef struct {
  * param k the number of blocks required to reconstruct
  * param m the total number of blocks created
  */
-fec_t* fec_new(unsigned k, unsigned m);
+fec_t* fec_new(unsigned short k, unsigned short m);
 void fec_free(fec_t* p);
 
 /**
@@ -64,7 +64,7 @@ void fec_decode(const fec_t* code, const gf*restrict const*restrict const inpkts
  * 
  * This file is part of zfec.
  * 
- * See README.txt for licensing information.
+ * See README.rst for licensing information.
  */
 
 /*