From 126ff375933fbe83d35e67aeaa2d145be1bc3af5 Mon Sep 17 00:00:00 2001 From: Andre Date: Wed, 22 Feb 2006 00:25:48 +0100 Subject: [PATCH] add documentation of struct plm_client_data --- plm_dbtool.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) 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 */ -- 2.39.2