From: zooko <zooko@zooko.com>
Date: Thu, 17 Jan 2008 20:46:16 +0000 (+0530)
Subject: doc: fix incorrect API doc which tripped up AGL -- sorry about that!
X-Git-Url: https://git.rkrishnan.org/pf/content/en/seg/index.php?a=commitdiff_plain;h=676f846662c6b7cac4f75a5e2afe28c55dc2c1fa;p=tahoe-lafs%2Fzfec.git

doc: fix incorrect API doc which tripped up AGL -- sorry about that!

darcs-hash:bf4416bc3289e20ce56ca9952d47244d87665f7b
---

diff --git a/zfec/zfec/fec.h b/zfec/zfec/fec.h
index db69d5f..6252f54 100644
--- a/zfec/zfec/fec.h
+++ b/zfec/zfec/fec.h
@@ -28,8 +28,7 @@ void fec_free(fec_t* p);
 /**
  * @param inpkts the "primary blocks" i.e. the chunks of the input data
  * @param fecs buffers into which the secondary blocks will be written
- * @param block_nums the numbers of the desired blocks -- including both primary blocks (the id < k) which fec_encode() ignores and check blocks (the id >= k) which fec_encode() will produce and store into the buffers of the fecs parameter
-XXX wrong -- it includes only the block nums of the secondary blocks
+ * @param block_nums the numbers of the desired check blocks (the id >= k) which fec_encode() will produce and store into the buffers of the fecs parameter
  * @param num_block_nums the length of the block_nums array
  */
 void fec_encode(const fec_t* code, const gf*restrict const*restrict const src, gf*restrict const*restrict const fecs, const unsigned*restrict const block_nums, size_t num_block_nums, size_t sz);