Merge pull request #871 from Yakindu/issue_609

make comments doxygen compatible: fixes #609

plugins/org.yakindu.sct.generator.cpp/src/org/yakindu/sct/generator/cpp/StatemachineInterface.xtend

@@ -31,8 +31,7 @@ class StatemachineInterface implements IContentTemplate {
 		#ifndef «statemachineInterface.define»_H_
 		#define «statemachineInterface.define»_H_
 		
-		/*
-		 * Basic interface for state machines.
+		/*! \file Basic interface for state machines.
 		 */
 		class «statemachineInterface»
 		{
@@ -40,35 +39,29 @@ class StatemachineInterface implements IContentTemplate {
 			
 				virtual ~«statemachineInterface»() = 0;
 				
-				/*
-				* Initializes the state machine. Used to initialize internal variables etc.
+				/*! Initializes the state machine. Used to initialize internal variables etc.
 				*/
 				virtual void init() = 0;
 			
-				/*
-				* Enters the state machine. Sets the state machine into a defined state.
+				/*! Enters the state machine. Sets the state machine into a defined state.
 				*/
 				virtual void enter() = 0;
 			
-				/*
-				* Exits the state machine. Leaves the state machine with a defined state.
+				/*! Exits the state machine. Leaves the state machine with a defined state.
 				*/
 				virtual void exit() = 0;
 			
-				/*
-				* Start a run-to-completion cycle.
+				/*! Start a run-to-completion cycle.
 				*/
 				virtual void runCycle() = 0;
 				
-				/*
-				* Checks whether the state machine is active. 
-			 	* A state machine is active if it has been entered. It is inactive if it has not been entered at all or if it has been exited.
+				/*! Checks whether the state machine is active. 
+			 	    A state machine is active if it has been entered. It is inactive if it has not been entered at all or if it has been exited.
 			 	*/	
 				virtual	sc_boolean isActive() = 0;
 				
-				/*
-				* Checks if all active states are final. 
-			 	* If there are no active states then the state machine is considered being inactive. In this case this method returns false.
+				/*! Checks if all active states are final. 
+			 		If there are no active states then the state machine is considered being inactive. In this case this method returns false.
 			 	*/
 				virtual sc_boolean isFinal() = 0;
 		};

plugins/org.yakindu.sct.generator.cpp/src/org/yakindu/sct/generator/cpp/TimedStatemachineInterface.xtend

@@ -34,28 +34,24 @@ class TimedStatemachineInterface implements IContentTemplate {
 		#include "«typesModule.h»"
 		#include "«timerInterface.h»"
 		
-		/*
-		* Interface for state machines which use timed event triggers.
+		/*! \file Interface for state machines which use timed event triggers.
 		*/
 		class «timedStatemachineInterface» {
 			public:
 			
 				virtual ~«timedStatemachineInterface»() = 0;
 				
-				/*
-				* Set the ITimerService for the state machine. It must be set
-				* externally on a timed state machine before a run cycle can be correct
-				* executed.
+				/*! Set the ITimerService for the state machine. It must be set
+				    externally on a timed state machine before a run cycle can be correct
+				    executed.
 				*/
 				virtual void setTimer(«timerInterface»* timer) = 0;
 				
-				/*
-				* Returns the currently used timer service.
+				/*! Returns the currently used timer service.
 				*/
 				virtual «timerInterface»* getTimer() = 0;
 				
-				/*
-				* Callback method if a time event occurred.
+				/*! Callback method if a time event occurred.
 				*/
 				virtual void «raiseTimeEventFctID»(sc_eventid event) = 0;
 		};

plugins/org.yakindu.sct.generator.cpp/src/org/yakindu/sct/generator/cpp/TimerInterface.xtend

@@ -36,8 +36,7 @@ class TimerInterface implements IContentTemplate {
 		//forward declaration of TimedStatemachineInterface to avoid cyclic dependency
 		class TimedStatemachineInterface;
 		
-		/*
-		 * Basic interface for state machines.
+		/*! \file Basic interface for state machines.
 		 */
 		class «timerInterface»
 		{
@@ -45,19 +44,16 @@ class TimerInterface implements IContentTemplate {
 				
 				virtual ~«timerInterface»() = 0;
 			
-				/*
-				 * Starts the timing for a time event.
+				/*! Starts the timing for a time event.
 				 */ 
 				virtual void setTimer(«timedStatemachineInterface»* statemachine, sc_eventid event, sc_integer time, sc_boolean isPeriodic) = 0;
 				
-				/*
-				 * Unsets the given time event.
+				/*! Unsets the given time event.
 				 */
 				virtual void unsetTimer(«timedStatemachineInterface»* statemachine, sc_eventid event) = 0;
 			
-				/*
-				 * Cancel timer service. Use this to end possible timing threads and free
-				 * memory resources.
+				/*! Cancel timer service. Use this to end possible timing threads and free
+				 	 memory resources.
 				 */
 				virtual void cancel() = 0;
 		};