afh

diff --git a/afh.c b/afh.c
index 4468cc8a76d3bbcc5f82ff4a9dcfc6e96512b696..84667dd44b4de8601f0d00bc809f08784191f829 100644 (file)
--- a/afh.c
+++ b/afh.c
@@ -1,6 +1,14 @@
 /* Copyright (C) 2008 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
-/** \file afh.c Paraslash's standalone audio format handler tool. */
+/** \file afh.c Paraslash's standalone audio format handler
+ *
+ * The para_afh(1) tool incorporates all supported audio format handlers.
+ * It does not employ the paraslash scheduler.
+ *
+ * There is only one non-static function in this file: main().
+ */
+
+/** \cond */
 
 #include <lopsub.h>
 
@@ -197,13 +205,22 @@ static void handle_help_flags(void)
        exit(EXIT_SUCCESS);
 }
 
-/**
- * The main function of para_afh.
+/** \endcond
+ *
+ * List audio format handler information or modify tags.
+ *
+ * Iterate over all given paths. At each iteration, call \ref mmap_full_file()
+ * to map the file into memory and \ref compute_afhi() to detect its format
+ * and to initialize an \ref afh_info structure.
+ *
+ * In default mode call \ref afh_get_afhi_txt() to pretty-print the thusly
+ * obtained audio format handler information. In modify mode, call \ref
+ * afh_rewrite_tags() instead to modify the tags.
  *
- * \param argc Usual argument count.
- * \param argv Usual argument vector.
+ * \param argc Options are defined in the afh lopsub suite.
+ * \param argv The afh suite defines no subcommands.
  *
- * \return \p EXIT_FAILURE or \p EXIT_SUCCESS.
+ * \return EXIT_FAILURE or EXIT_SUCCESS.
  */
 int main(int argc, char **argv)
 {