Changeset 18043 for branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Interfaces/IResultFormatter.cs

Timestamp:

08/11/21 13:05:27 (3 years ago)

Author:

dpiringe

Message:

#3026

• code cleanup

File:

• branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Interfaces/IResultFormatter.cs (modified) (1 diff)

branches/3026_IntegrationIntoSymSpace/HeuristicLab.JsonInterface/Interfaces/IResultFormatter.cs

@@ -1 +1 @@
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace HeuristicLab.JsonInterface {
   public interface IResultFormatter {
+    /// <summary>
+    /// A given priority, higher numbers are prior.
+    /// </summary>
     int Priority { get; }
 
+    /// <summary>
+    /// Checks if the given type can be formatted
+    /// </summary>
+    /// <param name="t"></param>
+    /// <returns></returns>
     bool CanFormatType(Type t);
 
+    /// <summary>
+    /// The format method which formats and object into a string (which can be saved in a JSON file).
+    /// </summary>
+    /// <param name="o"></param>
+    /// <returns></returns>
     string Format(object o);
   }