mp3_afh.c: Documentation update
authorAndre Noll <maan@systemlinux.org>
Tue, 13 Mar 2007 23:28:15 +0000 (00:28 +0100)
committerAndre Noll <maan@systemlinux.org>
Tue, 13 Mar 2007 23:28:15 +0000 (00:28 +0100)
mp3_afh.c

index 8f36bb8..c49d9bc 100644 (file)
--- a/mp3_afh.c
+++ b/mp3_afh.c
@@ -187,15 +187,13 @@ static int compare_headers(struct mp3header *h1,struct mp3header *h2)
        return 0;
 }
 
-/**
+/*
  * get next MP3 frame header.
  *
- * \param stream to read the header from
- * \param header structure that gets filled in by get_header()
- *
- * \return On success, the header frame length is returned.  A return value of
- * zero means that we did not retrieve a valid frame header, and a negative
- * return value indicates an error.
+ * On success, the header frame length is returned and the given header
+ * structure that is filled in.  A return value of zero means that we did not
+ * retrieve a valid frame header, and a negative return value indicates an
+ * error.
  */
 static int get_header(unsigned char *map, off_t numbytes, off_t *fpos,
        struct mp3header *header)
@@ -233,9 +231,9 @@ out:
 /**
  * find the next mp3 header
  *
- * \return On success, the length of the next frame header. If the end of the
- * file was reached, the function returns zero. On errors, a negative value is
- * returned.
+ * On success, the length of the next frame header is returned. If the end of
+ * the file was reached, the function returns zero. On errors, a negative value
+ * is returned.
  *
  */
 static int mp3_seek_next_header(unsigned char *map, off_t numbytes, off_t *fpos)