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

[tahoe-lafs/zfec.git] / zfec / zfec / fec.h

diff --git a/zfec/zfec/fec.h b/zfec/zfec/fec.h
index db69d5f8c419d7eba6665e5a6bb53b759d1cedaa..6252f5488360c041d2b66738523b0bf32c9fda50 100644 (file)
--- 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);