From: Andre Noll <maan@systemlinux.org>
Date: Sun, 11 Feb 2007 15:08:09 +0000 (+0100)
Subject: compress.c, wav.c: add documentation
X-Git-Tag: v0.2.15~27
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=eb0b03d2d24db75d1ece27b1cec133fc7df7d1c3;p=paraslash.git

compress.c, wav.c: add documentation
---

diff --git a/compress.c b/compress.c
index 936ddc3a..685c3ba9 100644
--- a/compress.c
+++ b/compress.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -133,7 +133,11 @@ static void open_compress(struct filter_node *fn)
 	pcd->max_gain = 1 << (pcd->conf->inertia_arg + pcd->conf->aggressiveness_arg);
 }
 
-/** the init function of the compress filter */
+/**
+ * the init function of the compress filter
+ *
+ * \param f pointer to the struct to initialize
+ */
 void compress_init(struct filter *f)
 {
 	f->open = open_compress;
diff --git a/wav.c b/wav.c
index 5ab3bb39..308c8bc1 100644
--- a/wav.c
+++ b/wav.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -25,15 +25,30 @@
 #include "filter.h"
 #include "string.h"
 
+/** size of the output buffer */
 #define WAV_OUTBUF_SIZE 81920
+/** a wav header is always 44 bytes */
 #define WAV_HEADER_LEN 44
+/** always write 16 bit header */
 #define BITS 16
 
-/* derived from oggdec.c of the vorbis-tools-1.0.1 package */
+/**
+ * write a 32 bit unsigned value to a buffer
+ *
+ * \param buf the buffer to write to
+ * \param x the value to write
+ */
 #define WRITE_U32(buf, x) (buf)[0] = (unsigned char)((x) & 0xff);\
 	(buf)[1] = (unsigned char)(((x) >> 8) & 0xff);\
 	(buf)[2] = (unsigned char)(((x) >> 16) & 0xff);\
 	(buf)[3] = (unsigned char)(((x) >> 24) & 0xff);
+
+/**
+ * write a 16 bit unsigned value to a buffer
+ *
+ * \param buf the buffer to write to
+ * \param x the value to write
+ */
 #define WRITE_U16(buf, x) (buf)[0] = (unsigned char)((x) & 0xff);
 
 static void make_wav_header(int channels, int samplerate, struct filter_node *fn)
@@ -100,6 +115,11 @@ static void wav_open(struct filter_node *fn)
 		fn, fn->buf, fn->loaded);
 }
 
+/**
+ * the init function of the wav filter
+ *
+ * \param f struct to initialize
+ */
 void wav_init(struct filter *f)
 {
 	f->convert = wav_convert;