afh_common: Improve documentation of clear_afh().

[paraslash.git] / afh_common.c

diff --git a/afh_common.c b/afh_common.c
index 6c161a7c7ea2a30c0abb6a87c91ef5075d5dbf06..b3ba348526cad86c103bcff65e3765fc3b571e2a 100644 (file)
--- a/afh_common.c
+++ b/afh_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2014 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -31,6 +31,10 @@ void mp3_init(struct audio_format_handler *);
        void flac_afh_init(struct audio_format_handler *);
 #endif
 
+#ifdef HAVE_OPUS
+       void opus_afh_init(struct audio_format_handler *);
+#endif
+
 void wma_afh_init(struct audio_format_handler *);
 
 /** The list of all status items */
@@ -79,6 +83,12 @@ static struct audio_format_handler afl[] = {
                .name = "flac",
 #ifdef HAVE_FLAC
                .init = flac_afh_init,
+#endif
+       },
+       {
+               .name = "opus",
+#ifdef HAVE_OPUS
+               .init = opus_afh_init,
 #endif
        },
        {
@@ -220,11 +230,12 @@ success:
 }
 
 /**
- * Deallocate contents of a filled-in ahi structure
+ * Deallocate the contents of an afh_info structure.
  *
  * \param afhi The structure to clear.
  *
- * The given pointer is kept, everything else is freed.
+ * This only frees the memory the various pointer fields of \a afhi point to.
+ * It does *not* free \a afhi itself.
  */
 void clear_afhi(struct afh_info *afhi)
 {