doxify recv.c
[paraslash.git] / recv.c
diff --git a/recv.c b/recv.c
index 35f6948..1bbef74 100644 (file)
--- a/recv.c
+++ b/recv.c
@@ -16,7 +16,7 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
-/** \file recv.c the stand-alone receiver */
+/** \file recv.c the stand-alone audio stream receiver */
 
 #include "para.h"
 
 #include "error.h"
 #include "stdout.h"
 
+/** the gengetopt args info struct */
 struct recv_args_info conf;
 
-INIT_RECV_ERRLISTS;
+/** always log to stderr */
+INIT_STDERR_LOGGING(conf.loglevel_arg);
 
+/** init array of error codes used by para_recv */
+INIT_RECV_ERRLISTS;
 
-INIT_STDERR_LOGGING(conf.loglevel_arg);
 static void *parse_config(int argc, char *argv[], int *receiver_num)
 {
        int i;
@@ -59,10 +62,21 @@ static void rn_event_handler(struct task *t)
        unregister_task(t);
 }
 
+/**
+ * the main function of para_recv
+ *
+ * \param argc number of arguments
+ * \param argv vector of arguments
+ *
+ * para_recv uses the specified receiver to receive an audio stream sent by
+ * para_server. The received data is written to stdout.
+ *
+ * \return \a EXIT_SUCCESS on success, \a EXIT_FAILURE on errors.
+ */
 int main(int argc, char *argv[])
 {
        int ret, r_opened = 0, receiver_num;
-       struct  receiver *r = NULL;
+       struct receiver *r = NULL;
        struct receiver_node rn;
        struct stdout_task sot;
        struct sched s;
@@ -107,5 +121,5 @@ out:
                r->shutdown();
        if (ret < 0)
                PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-       return ret;
+       return ret < 0? EXIT_FAILURE : EXIT_SUCCESS;
 }