dox

diff --git a/recv.c b/recv.c
index 7c0fe3a1803dc221d3e36b0e0cabe077bd249589..f5942d36343548dde7d34efe085b2d3f9cb300e1 100644 (file)
--- a/recv.c
+++ b/recv.c
@@ -1,6 +1,14 @@
 /* Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
 
-/** \file recv.c the stand-alone audio stream receiver */
+/** \file recv.c the stand-alone audio stream receiver
+ *
+ * This file contains the main function of para_recv(1). All receivers and
+ * the stdout buffer tree node are linked into the executable. The file
+ * does not define any public symbols, but calls some of the helpers of
+ * \ref recv_common.c to check the receiver arguments, then calls into \ref
+ * stdout.c to register the stdout task.
+ *
+ * \cond doxygen_ignore */
 
 #include <sys/types.h>
 #include <lopsub.h>
@@ -16,7 +24,7 @@
 #include "error.h"
 #include "stdout.h"
 
-/** Array of error strings. */
+/* Array of error strings. */
 DEFINE_PARA_ERRLIST;
 
 #define CMD_PTR (lls_cmd(0, recv_suite))
@@ -27,7 +35,7 @@ DEFINE_PARA_ERRLIST;
 #define OPT_STRING_VAL(_name, _lpr) (lls_string_val(0, OPT_RESULT(_name, _lpr)))
 
 static int loglevel;
-/** Always log to stderr. */
+/* Always log to stderr. */
 INIT_STDERR_LOGGING(loglevel);
 
 static void handle_help_flag(struct lls_parse_result *lpr)
@@ -46,16 +54,23 @@ static void handle_help_flag(struct lls_parse_result *lpr)
        exit(EXIT_SUCCESS);
 }
 
-/**
+/** \endcond doxygen_ignore
+ *
  * The main function of para_recv.
  *
- * \param argc number of arguments
- * \param argv vector of arguments
+ * \param argc Command line options are parsed by the lopsub library.
+ *
+ * \param argv Options are defined in the lopsub suite file of the source tree
+ * (not part of the doxygen system). A separate suite file defines the options
+ * of the receivers where each receiver corresponds to a lopsub subcommand.
  *
- * para_recv uses the specified receiver to receive an audio stream sent by
- * para_server. The received data is written to stdout.
+ * para_recv receives an audio stream and writes received it to stdout.
+ * If the afh receiver is specified, the stream is "received" from a local
+ * audio file, otherwise, it is received from the network. In any case,
+ * a buffer tree with two nodes is created where the root node corresponds
+ * to the given receiver. Its child node corresponds to the stdout task.
  *
- * \return \a EXIT_SUCCESS on success, \a EXIT_FAILURE on errors.
+ * \return EXIT_SUCCESS on success, EXIT_FAILURE on errors.
  */
 int main(int argc, char *argv[])
 {