From: Andre Noll <maan@systemlinux.org>
Date: Sun, 14 Apr 2013 09:57:12 +0000 (+0200)
Subject: check_wav.c: Fix documentation of check_wav_post_select().
X-Git-Tag: v0.4.13~34^2~2
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=4a60614bad4706967f0c3f57695ee1c85c2b0d96

check_wav.c: Fix documentation of check_wav_post_select().

This function does not take a pointer to a buffer tree node, yet the
comment referred to "btrn". Simply drop this part of the sentence.
---

diff --git a/check_wav.c b/check_wav.c
index 872a7d0a..11459e08 100644
--- a/check_wav.c
+++ b/check_wav.c
@@ -116,8 +116,8 @@ out:
  * This function looks at the first \p WAV_HEADER_SIZE bytes of the input queue
  * of the btrn of \a cwc. If they look like a wav header, the function extracts
  * the information of interest and swallows this part of the stream. Otherwise
- * it is pushed down to all children of \a btrn. In either case the rest of the
- * input is pushed down as well.
+ * it is pushed down to all children. In either case the rest of the input is
+ * pushed down as well.
  *
  * Once the first part has been processed this way, the state of the instance
  * changes from \p CWS_NEED_HEADER to \p CWS_HAVE_HEADER or \p CWS_NO_HEADER.