flacdec: Improve documentation of unconsumed.
authorAndre Noll <maan@systemlinux.org>
Tue, 3 Sep 2013 22:13:21 +0000 (22:13 +0000)
committerAndre Noll <maan@systemlinux.org>
Sun, 27 Oct 2013 08:40:09 +0000 (09:40 +0100)
Mention that this variable stores the number of unconsumed
bytes *that have already been fed* to the decoder.

flacdec_filter.c

index 09b319a..621d50d 100644 (file)
@@ -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;
 };