From 6494c65af41cd12bf3de545998df8a4b0a5db3b5 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Wed, 28 Dec 2016 02:08:54 +0100 Subject: [PATCH] fade: Add documentation for main() and include it in doxygen. The two mixer implementations for OSS and ALSA are also included, both of which are only used by para_fade. So it makes sense to include para_fade as well. main() is the only a non-static function, so let's doxify that. --- Doxyfile | 1 - fade.c | 11 +++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/Doxyfile b/Doxyfile index 50c74695..df6c87fd 100644 --- a/Doxyfile +++ b/Doxyfile @@ -797,7 +797,6 @@ EXCLUDE_SYMLINKS = NO EXCLUDE_PATTERNS = *.cmdline.* \ gcc-compat.h \ - fade.c \ *.command_list.h \ *.completion.h diff --git a/fade.c b/fade.c index e05e3173..95bb1d59 100644 --- 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; -- 2.30.2