#428 Doxygen fix

Signed-off-by: Dimitri Baron <[email protected]>
dynawo · Nov 12, 2024 · f989ac1 · f989ac1
1 parent 1bebb23
commit f989ac1
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/sources/Common/DYNSimulationResult.h b/sources/Common/DYNSimulationResult.h
@@ -127,8 +127,16 @@ class SimulationResult {
    */
   std::string getLostEquipementsStreamStr() const;
 
+  /**
+   * @brief getter of the final state IIDM stream associated to the scenario
+   * @return final state IIDM stream associated to the scenario
+   */
   std::stringstream& getOutputIIDMStream();
 
+  /**
+   * @brief getter of the final state IIDM associated to the scenario
+   * @return final state IIDM associated to the scenario
+   */
   std::string getOutputIIDMStreamStr() const;
 
   /**
@@ -252,7 +260,7 @@ class SimulationResult {
   std::stringstream timelineStream_;  ///< stream for the timeline associated to the scenario
   std::stringstream constraintsStream_;  ///< stream for the constraints associated to the scenario
   std::stringstream lostEquipmentsStream_;  ///< stream for the lost equipments associated to the scenario
-  std::stringstream outputIIDMStream_;
+  std::stringstream outputIIDMStream_;  ///< stream for the output final state IIDM dump associated to the scenario
   std::string scenarioId_;  ///< id of the scenario
   double variation_;  ///< variation of the scenario (aka loadLevel when associated to a load increase)
   bool success_;  ///< @b true if the simulation reached its end, @b false otherwise