From: Andre <maan@meins.(none)>
Date: Thu, 21 Sep 2006 19:22:52 +0000 (+0200)
Subject: audiod struct status_task documentation update
X-Git-Tag: v0.2.14~12
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=f0b8a4b1413b23d52dffdf2baacc77878c415882;p=paraslash.git

audiod struct status_task documentation update
---

diff --git a/audiod.h b/audiod.h
index 856bc051..6f64a5b7 100644
--- a/audiod.h
+++ b/audiod.h
@@ -50,13 +50,14 @@ struct audiod_task {
 };
 
 /**
- * the task for audiod's child (para_client stat)
+ * the task for obtaining para_server's status (para_client stat)
  *
  * \sa struct task, struct sched
  */
 struct status_task {
 	/** the associated task structure of audiod */
 	struct task task;
+	/** client data associated with the stat task */
 	struct private_client_data *pcd;
 	/** the array of status items sent by para_server */
 	char *stat_item_values[NUM_STAT_ITEMS];
@@ -70,11 +71,11 @@ struct status_task {
 	int length_seconds;
 	/** the start of the current stream from the view of para_server */
 	struct timeval server_stream_start;
-	/** the averaged time deviation between para_server and para_audiod */
+	/** the average time deviation between para_server and para_audiod */
 	struct timeval sa_time_diff;
 	/** whether client time is ahead of server time */
 	int sa_time_diff_sign;
-	/** non-zero if \a af_status is "playing" */
+	/** non-zero if para_server's status is "playing" */
 	int playing;
 };