add documentation of struct plm_client_data
authorAndre <maan@p133.(none)>
Tue, 21 Feb 2006 23:25:48 +0000 (00:25 +0100)
committerAndre <maan@p133.(none)>
Tue, 21 Feb 2006 23:25:48 +0000 (00:25 +0100)
plm_dbtool.c

index 4597e15..3b551fc 100644 (file)
 #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 */