From: Andre <maan@p133.(none)>
Date: Fri, 5 Jan 2007 19:48:11 +0000 (+0100)
Subject: doxify recv.c
X-Git-Tag: v0.2.15~106
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=47a91602a972646e098874c0bcfed5350d130edb;hp=b9f9601828dd1a103ec9315bd430d39b458d2b80

doxify recv.c

Also, fix the return value of main().
---

diff --git a/Doxyfile b/Doxyfile
index c5e103b5..85cc80e7 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -487,7 +487,7 @@ EXCLUDE_SYMLINKS       = NO
 # against the file with absolute path, so to exclude all test directories 
 # for example use the pattern */test/*
 
-EXCLUDE_PATTERNS = list.h *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h recv.c para.h fade.c config.h sdl_gui.c slider.c dbadm.c
+EXCLUDE_PATTERNS = list.h *.cmdline.* krell.* gui* SFont* gcc-compat.h rc4.h para.h fade.c config.h sdl_gui.c slider.c dbadm.c
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 
 # directories that contain example code fragments that are included (see 
diff --git a/recv.c b/recv.c
index 35f6948c..1bbef743 100644
--- 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"
 
@@ -28,12 +28,15 @@
 #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;
 }