fade: Add documentation for main() and include it in doxygen.

[paraslash.git] / fade.c

diff --git a/fade.c b/fade.c
index e05e31733623dacae4beddad69580d077ad23a0d..95bb1d59ffd60f277f4569e44c8909c3fe060c76 100644 (file)
--- a/fade.c
+++ b/fade.c
@@ -333,6 +333,17 @@ __noreturn static void print_help_and_die(void)
        exit(0);
 }
 
+/**
+ * The main function of para_fade.
+ *
+ * The executable is linked with the alsa or the oss mixer API, or both. It has
+ * a custom log function which prefixes log messages with the current date.
+ *
+ * \param argc Argument counter.
+ * \param argv Argument vector.
+ *
+ * \return EXIT_SUCCESS or EXIT_FAILURE.
+ */
 int main(int argc, char *argv[])
 {
        int ret;