]> git.tuebingen.mpg.de Git - paraslash.git/blobdiff - afh_common.c
Small cleanups and documentation improvements.
[paraslash.git] / afh_common.c
index 13bcd0d3143214bf10473673bfe2c833af597a41..e6e77ae4dff20bcf80b7049d6c472a0a01820c7c 100644 (file)
@@ -3,7 +3,8 @@
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
-/* \file afh_common.c: Common audio format handler functions. */
+
+/** \file afh_common.c Common audio format handler functions. */
 
 #include <sys/mman.h> /* mmap */
 #include <sys/time.h> /* gettimeofday */
@@ -26,7 +27,7 @@ void mp3_init(struct audio_format_handler *);
 #endif
 
 /**
- * The list of supported  audio formats.
+ * The list of supported audio formats.
  *
  * We always define the full array of audio formats even if some audio formats
  * were not compiled in. This is because for each audio file the number of its
@@ -89,9 +90,9 @@ void afh_init(void)
 
 
 /**
- * guess the audio format judging from filename
+ * Guess the audio format judging from filename.
  *
- * \param name the filename
+ * \param name The filename.
  *
  * \return This function returns -1 if it has no idea what kind of audio
  * file this might be. Otherwise the (non-negative) number of the audio format