Document Message Queue variables.

[wsti_so.git] / src / process3.c

diff --git a/src/process3.c b/src/process3.c
index 6453a8fe2bbac70f8cf1b41e1d947aacdf198d00..91212e991a1cc3ff0363e1a8f157fa5df5a7bc8b 100644 (file)
--- a/src/process3.c
+++ b/src/process3.c
@@ -35,7 +35,8 @@ key_t shmkey = 18912;
 int shmid;
 
 /**
- * Message shared by processes. Contains array of process IDs
+ * Structure holding array of process IDs.
+ * Message is shared by processes. Contains array of process IDs
  */
 struct message {
        pid_t pids[3];
@@ -44,11 +45,24 @@ struct message {
 struct message * processes = NULL;
 
 /**
- * Message queue variables
+ * Message Queue variables
+ */
+
+/**
+ * Unique key of message queue.
  */
 key_t qkey = 12356;
+
+/**
+ * Queue descriptor.
+ */
 int qid;
 
+/**
+ * Structure holding queue message data.
+ * Parameter mtype describes process to whom message is sent.
+ * Parameter signo is a signal to raise after getting message.
+ */
 struct queue_message {
        long mtype;
        int signo[1];