fix for typo in SimController comment

OpenModelica · May 22, 2015 · 6f309c9 · 6f309c9
1 parent 8a7b5a0
commit 6f309c9
Showing 1 changed file with 18 additions and 20 deletions.
diff --git a/SimulationRuntime/cpp/Include/Core/SimController/ISimController.h b/SimulationRuntime/cpp/Include/Core/SimController/ISimController.h
@@ -34,37 +34,33 @@ struct SimSettings
   LogType logType;
 };
 
-/*SimController to start and stop the simulation*/
+/**
+ *  SimController to start and stop the simulation
+ */
 class ISimController
 {
 
 public:
-  /// Enumeration to control the time integration
+
   virtual ~ISimController() {};
-/*
-#if defined(__vxworks) || defined(__TRICORE__)
-#else
-  virtual std::pair<boost::shared_ptr<IMixedSystem>,boost::shared_ptr<ISimData> > LoadSystem(boost::shared_ptr<ISimData> (*createSimDataCallback)(), boost::shared_ptr<IMixedSystem> (*createSystemCallback)(IGlobalSettings*, boost::shared_ptr<IAlgLoopSolverFactory>, boost::shared_ptr<ISimData>), string modelKey)=0;
-#endif
-*/
   virtual boost::weak_ptr<IMixedSystem> LoadSystem(string modelLib,string modelKey) = 0;
   virtual boost::weak_ptr<IMixedSystem> LoadModelicaSystem(PATH modelica_path,string modelKey) = 0;
   virtual boost::weak_ptr<ISimData> LoadSimData(string modelKey) = 0;
-  /*
+  /**
   Creates  SimVars object, stores all model variable in continuous block of memory
-     @modelKey  model name
-     @dim_real  number of all real variables (real algebraic vars,discrete algebraic vars, state vars, der state vars)
-     @dim_int   number of all integer variables integer algebraic vars
-     @dim_bool  number of all bool variables (boolean algebraic vars)
-     @dim_pre_vars number of all pre variables (real algebraic vars,discrete algebraic vars, boolean algebraic vars, integer algebraic vars, state vars, der state vars)
-     @dim_z number of all state variables
-     @z_i start index of state vector in real_vars list
+     @param  model name
+     @param dim_real  number of all real variables (real algebraic vars,discrete algebraic vars, state vars, der state vars)
+     @param dim_int   number of all integer variables integer algebraic vars
+     @param dim_bool  number of all bool variables (boolean algebraic vars)
+     @param dim_pre_vars number of all pre variables (real algebraic vars,discrete algebraic vars, boolean algebraic vars, integer algebraic vars, state vars, der state vars)
+     @param dim_z number of all state variables
+     @param z_i start index of state vector in real_vars list
      */
   virtual boost::weak_ptr<ISimVars> LoadSimVars(string modelKey,size_t dim_real,size_t dim_int,size_t dim_bool,size_t dim_pre_vars,size_t dim_z,size_t z_i) = 0;
-  /*
+  /**
   Starts the simulation
-  modelKey: Modelica model name
-  modelica_path: path to Modelica system dll
+  @param modelKey Modelica model name
+  @param modelica_path: path to Modelica system dll
   */
   virtual void Start(SimSettings simsettings, string modelKey)=0;
 
@@ -74,7 +70,9 @@ class ISimController
   virtual boost::weak_ptr<IMixedSystem> getSystem(string modelname) = 0;
   virtual void calcOneStep() = 0;
 
-  /// Stops the simulation
+  /**
+   *    Stops the simulation
+   */
   virtual void Stop() = 0;
 };
 /** @} */ // end of coreSimcontroller