From: Andre <maan@p133.(none)>
Date: Tue, 21 Feb 2006 23:25:48 +0000 (+0100)
Subject: add documentation of struct plm_client_data
X-Git-Tag: v0.2.11~55
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=126ff375933fbe83d35e67aeaa2d145be1bc3af5;p=paraslash.git

add documentation of struct plm_client_data
---

diff --git a/plm_dbtool.c b/plm_dbtool.c
index 4597e15c..3b551fcd 100644
--- a/plm_dbtool.c
+++ b/plm_dbtool.c
@@ -25,10 +25,17 @@
 #include "string.h"
 #include "ipc.h"
 
+/**
+ * structure used for transmission of the playlist
+ *
+ * There's one such struct which gets initialized during startup. It lives in
+ * shared memory and is used by com_lpl().
+ */
 struct plm_client_data {
-	size_t size;
 /** allocated and set by com_lpl() (child) */
 	int shm_id;
+/** the size of the shared memory area identified by \a shm_id */
+	size_t size;
 /** initially locked, gets unlocked by parent when it is done */
 	int mutex;
 /** return value, set by parent */