afh: Expand documentation of init function declarations.
authorAndre Noll <maan@tuebingen.mpg.de>
Tue, 13 Jun 2017 21:21:34 +0000 (23:21 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Sun, 25 Jun 2017 18:11:09 +0000 (20:11 +0200)
It's not obvious why all of these are declared here, so explain this
in a bit more detail.

afh_common.c

index 6feb7c3..0d8d905 100644 (file)
 #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;