Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/message_structures.h

Timestamp:

Jul 14, 2004, 3:31:42 PM (21 years ago)

Author:

chris

Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:

• orxonox/branches/chris/src/message_structures.h (modified) (2 diffs)

orxonox/branches/chris/src/message_structures.h

@@ +1 @@
+/*!
+        \file message_structures.h
+        \brief contains defintitons of messages that can be passed between classes
+*/
 
 #ifndef _MESSAGESTRUCTURES_H
@@ -5 +9 @@
 #define CMD_LENGHT 16
 
-        // structure that contains commands
+//! structure that contains a command message
 typedef struct
 {
-        char cmd[CMD_LENGHT];
-        bool bUp;
+        char cmd[CMD_LENGHT];   //!< the command delivered
+        bool bUp;       //!< false = command was activated / true = command was deactivated
+        
+        //! if cmd is "cursor" the coordinates of the mouse cursor are stored here
+        //!@{
         Uint16 x, y;
-        Sint16 xrel, yrel;
+        //!@}
+        
+        //! if cmd is "cursor" the relative motion of the mouse cursor is stored here
+        //!@{
+        Sint16 xrel, yrel; 
+        //!@}
 } Command;