From: Andre Noll <maan@systemlinux.org>
Date: Tue, 3 Sep 2013 22:13:21 +0000 (+0000)
Subject: flacdec: Improve documentation of unconsumed.
X-Git-Tag: v0.5.1~4^2~4
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=464648bb2c7d75586dfee44917ca731e491ae01e;p=paraslash.git

flacdec: Improve documentation of unconsumed.

Mention that this variable stores the number of unconsumed
bytes *that have already been fed* to the decoder.
---

diff --git a/flacdec_filter.c b/flacdec_filter.c
index 09b319a0..621d50d2 100644
--- a/flacdec_filter.c
+++ b/flacdec_filter.c
@@ -25,7 +25,7 @@ struct private_flacdec_data {
 	 * We can not consume directly what was copied by the read callback
 	 * because we might need to feed unconsumend bytes to the decoder again
 	 * after the read callback ran out of data and returned ABORT. So we
-	 * track how many bytes are unconsumed so far.
+	 * track how many bytes have been fed to libflac but are unconsumed so far.
 	 */
 	size_t unconsumed;
 };