add documentation of struct plm_client_data

diff --git a/plm_dbtool.c b/plm_dbtool.c
index 4597e15c71ab5747a8730c91d48e71a43a31ae40..3b551fcd5e36ab68e227a0364e1fa6e9b3fc877c 100644 (file)
--- a/plm_dbtool.c
+++ b/plm_dbtool.c
@@ -25,10 +25,17 @@
 #include "string.h"
 #include "ipc.h"
 
 #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 {
 struct plm_client_data {

-       size_t size;

 /** allocated and set by com_lpl() (child) */
        int shm_id;
 /** 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 */
 /** initially locked, gets unlocked by parent when it is done */
        int mutex;
 /** return value, set by parent */