Changeset 7301 for code/trunk/src/libraries/core/EventIncludes.h

Timestamp:

Aug 31, 2010, 11:31:37 PM (14 years ago)

Author:

dafrick

Message:

Improving documentation for MultiTriggers, also some small bugfixes, simplifications and added features.

File:

• code/trunk/src/libraries/core/EventIncludes.h (modified) (2 diffs)

code/trunk/src/libraries/core/EventIncludes.h

@@ -53 +53 @@
     XMLPortEventStateIntern(xmlportevent##function, classname, statename, xmlelement, mode)
 
+/**
+    @brief Like XMLPortEventState but creates an event sink instead of an event state.
+           The most important destinction between an EventState and an EventSink is, that an EventState only processes events which change the state of the EventState, where as an EventSink is an EventState that processes any Event that reaches it.
+*/
+
 #define XMLPortEventSink(classname, subclassname, statename, function, xmlelement, mode) \
     orxonox::EventState* containername##function = this->getEventState(statename); \
@@ -62 +67 @@
     XMLPortEventStateIntern(xmlportevent##function, classname, statename, xmlelement, mode)
 
-/**
-    @brief Like XMLPortEventState but creates an event sink instead of an event state.
-           The most important destinction between an EventState and an EventSink is, that an EventState only processes event which change the state of the EventState, where as an EventSink is an EventState that processes any Event that reaches it.
-*/
+
 #define XMLPortEventStateTemplate(classname, subclassname, statename, function, xmlelement, mode, ...) \
     orxonox::EventState* containername##function = this->getEventState(statename); \