doxify acl.c.

[paraslash.git] / afh_common.c

diff --git a/afh_common.c b/afh_common.c
index 13bcd0d3143214bf10473673bfe2c833af597a41..e71fca1119d8ea5d292ef2ae34515d4fcfa693d0 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -1,9 +1,10 @@
 /*
- * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2008 Andre Noll <maan@systemlinux.org>
  *
  * 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
@@ -74,11 +75,14 @@ static inline int next_audio_format(int format)
 /** Iterate over each supported audio format. */
 #define FOR_EACH_AUDIO_FORMAT(i) for (i = 0; afl[i].name; i = next_audio_format(i))
 
+/**
+ * Call the init function of each supported audio format handler.
+ */
 void afh_init(void)
 {
        int i;
 
-       PARA_DEBUG_LOG("supported audio formats: %s\n",
+       PARA_INFO_LOG("supported audio formats: %s\n",
                SUPPORTED_AUDIO_FORMATS);
        FOR_EACH_AUDIO_FORMAT(i) {
                PARA_NOTICE_LOG("initializing %s handler\n",
@@ -89,9 +93,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
@@ -137,7 +141,7 @@ int guess_audio_format(const char *name)
  * one is found that can handle the file.
  */
 int compute_afhi(const char *path, char *data, size_t size,
-               struct audio_format_info *afhi)
+               struct afh_info *afhi)
 {
        int ret, i, format = guess_audio_format(path);
 
@@ -152,7 +156,7 @@ int compute_afhi(const char *path, char *data, size_t size,
                ret = afl[i].get_file_info(data, size, afhi);
                if (ret >= 0)
                        return i;
-               PARA_WARNING_LOG("%s\n", PARA_STRERROR(-ret));
+               PARA_WARNING_LOG("%s\n", para_strerror(-ret));
        }
        return -E_AUDIO_FORMAT;
 }