X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=src%2Fglobal%2Fcomm.h;h=d9969a2f400587f09fc830d94f78330fb79d2017;hb=HEAD;hp=b5c7f304b9e4783f256c8ea576d1e876dca5bf25;hpb=f5e4ddbec282b9ede909f89dcdfff06b3f197de7;p=vlp.git

diff --git a/src/global/comm.h b/src/global/comm.h
index b5c7f30..d9969a2 100644
--- a/src/global/comm.h
+++ b/src/global/comm.h
@@ -1,5 +1,10 @@
-/*    Communication structures */
+/**
+ * @file
+ * @brief Communication structures
+ */
 
+#ifndef LOGLAN_COMM_H
+#define LOGLAN_COMM_H
 
 // REDHAT DEPENDENT !!!
 #include <netinet/tcp.h>
@@ -13,10 +18,10 @@ typedef struct {
 } paddr;
 
 typedef struct {
-	paddr sender;     /* address of the sender and */
-	paddr receiver;   /* receiver of the message */
-	int type;         /* message type */
-	int par;          /* prototype or error signal number */
+	paddr sender;     /** address of the sender and */
+	paddr receiver;   /** receiver of the message */
+	int type;         /** message type */
+	int par;          /** prototype or error signal number */
 } ctrl_msg;
 
 typedef struct {
@@ -35,8 +40,11 @@ typedef struct {
 	int program_id;
 } ctx_struct;
 
-/* Commm struct for GRAPH element */
-
+/**
+ * \defgroup GRAPH
+ * \brief Comm struct for GRAPH element
+ */
+/** @{ */
 #define GRAPH_ALLOCATE	1
 #define GRAPH_EXIT	2 
 #define GRAPH_FREE	3
@@ -78,9 +86,13 @@ typedef struct {
 
 #define GRAPH_MAGIC	37
 #define GRAPH_MAGIC_RESPONSE	38
+/** @} */
 
-/* INT element */
-
+/**
+ * \defgroup INT
+ * \brief Comm struct for INT element
+ */
+/** @{ */
 #define INT_CONNECTED	1
 #define INT_EXITING	2
 #define INT_CTX		3
@@ -91,11 +103,13 @@ typedef struct {
 #define INT_CLOSE_INSTANCE	8
 #define INT_KILL	9
 #define INT_START_OK	10
+/** @} */
 
-
-
-/* NET element */
-
+/**
+ * \defgroup NET
+ * \brief Comm struct for NET element
+ */
+/** @{ */
 #define NET_PROPAGATE	0
 #define NET_PROPAGATE_OUT 		1
 /*
@@ -142,9 +156,13 @@ typedef struct {
 #define NET_INFO_END		25
 #define NET_NODES_NUM		26
 #define NET_NODES_NUM_RESPONSE	27
+/** @} */
 
-/* VLP message */
-
+/**
+ * \defgroup VLP
+ * \brief VLP message
+ */
+/** @{ */
 #define VLP_WRITE		0
 #define VLP_REMOTE_INSTANCE	1
 #define VLP_REMOTE_INSTANCE_OK	2
@@ -153,10 +171,13 @@ typedef struct {
 #define VLP_REMOTE_INSTANCE_HERE	5
 #define VLP_CLOSE_INSTANCE		6
 #define VLP_INTERPRETER_DOWN		7
-/* ------------------------------------------------------------ */
-/*                Message structure                            */
-/*------------------------------------------------------------*/
+/** @} */
 
+/**
+ * \defgroup VLP
+ * \brief Message structure
+ */
+/** @{ */
 #define MSG_VLP		0
 #define MSG_NET		1
 #define MSG_GRAPH	2
@@ -175,4 +196,6 @@ typedef struct {
 } G_MESSAGE;
 
 #define TCP_BUFFER_SIZE	30*sizeof(MESSAGE);
+/** @} */
 
+#endif /* LOGLAN_COMM_H */