From: Andre Noll <maan@tuebingen.mpg.de>
Date: Tue, 13 Jun 2017 21:21:34 +0000 (+0200)
Subject: afh: Expand documentation of init function declarations.
X-Git-Tag: v0.6.1~52^2~1
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=149bccb4639bc4bd3d44d0a0ad49f9881cf3e94a;p=paraslash.git

afh: Expand documentation of init function declarations.

It's not obvious why all of these are declared here, so explain this
in a bit more detail.
---

diff --git a/afh_common.c b/afh_common.c
index 6feb7c35..0d8d905c 100644
--- a/afh_common.c
+++ b/afh_common.c
@@ -16,7 +16,16 @@
 #include "afh.h"
 
 typedef void afh_init_func(struct audio_format_handler *);
-/* It does not hurt to declare init functions which are not available. */
+/*
+ * Declaration of the audio format handler init functions.
+ *
+ * These symbols are referenced in the afl array below.
+ *
+ * Most audio format handlers depend on an external library and are not
+ * compiled in if the library is not installed. Hence it is well possible that
+ * not all of these functions are defined. It does not hurt to declare them
+ * anyway, and this avoids another set of ifdefs.
+ */
 extern afh_init_func mp3_init, ogg_init, aac_afh_init, wma_afh_init,
 	spx_afh_init, flac_afh_init, opus_afh_init;