Documentation fixes

[vlp.git] / src / global / comm.h

diff --git a/src/global/comm.h b/src/global/comm.h
index 27e754d3cea1527c0615d14bb359778b5ef1fc36..d9969a2f400587f09fc830d94f78330fb79d2017 100644 (file)
--- a/src/global/comm.h
+++ b/src/global/comm.h
@@ -1,4 +1,7 @@
-/*    Communication structures */
+/**
+ * @file
+ * @brief Communication structures
+ */
 
 #ifndef LOGLAN_COMM_H
 #define LOGLAN_COMM_H
@@ -15,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 {
@@ -37,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
@@ -80,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
@@ -93,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
 /*
@@ -144,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
@@ -155,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
@@ -177,5 +196,6 @@ typedef struct {
 } G_MESSAGE;
 
 #define TCP_BUFFER_SIZE        30*sizeof(MESSAGE);
+/** @} */
 
 #endif /* LOGLAN_COMM_H */