More Documentation improvments.

[paraslash.git] / oggdec.c

diff --git a/oggdec.c b/oggdec.c
index 54586b581da2b061bde62cf7a55e60a8deaffea6..3dced8a0baf58baf6617498c481668944e5ad183 100644 (file)
--- a/oggdec.c
+++ b/oggdec.c
@@ -17,25 +17,22 @@
 
 #include <vorbis/vorbisfile.h>
 
-/** \cond some internal constants */
-#define BITS 16
+/** Determine byte sex. */
 #ifdef WORDS_BIGENDIAN
 #define ENDIAN 1
 #else
 #define ENDIAN 0
 #endif
-#define SIGN 1
-/** \endcond */
 
-/** data specific to the oggdec filter */
+/** Data specific to the oggdec filter. */
 struct private_oggdec_data {
-       /** describes an ogg vorbis file */
+       /** Describes an ogg vorbis file. */
        OggVorbis_File *vf;
-       /** the input buffer */
+       /** The input buffer. */
        char *inbuf;
-       /** the length of \a inbuf */
+       /** The length of \a inbuf. */
        size_t inbuf_len;
-       /** the number of bytes consumed from the input buffer */
+       /** The number of bytes consumed from the input buffer. */
        size_t converted;
 };
 
@@ -155,7 +152,7 @@ static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
        while (!*fn->fc->input_eof && fn->loaded < fn->bufsize) {
                int length = fn->bufsize - fn->loaded;
                long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
-                       ENDIAN, BITS / 8, SIGN, NULL);
+                       ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
                if (read_ret == OV_HOLE || !read_ret)
                        return pod->converted;
                if (read_ret < 0)
@@ -174,7 +171,11 @@ static void *oggdec_parse_config(int argc, char **argv)
        return NULL;
 }
 
-/** the init function of the ogg vorbis decoder */
+/**
+ * The init function of the ogg vorbis decoder.
+ *
+ * \param f Its fields are filled in by the function.
+ */
 void oggdec_init(struct filter *f)
 {
        f->open = ogg_open;