Changeset 17025 for branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/Attributes

Timestamp:

06/19/19 13:28:34 (5 years ago)

Author:

dpiringe

Message:

#2924:

• added base attribute CLIBaseAttribute for CLI attributes, which contains the property Description
• changed inheritance from Attribute to CLIBaseAttribute for types: CommandAttribute, OptionAttribute and ValueAttribute
• added comment in RunnerHost

Location:

branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/Attributes

Files:

• CLIBaseAttribute.cs (added)
• CommandAttribute.cs (modified) (3 diffs)
• OptionAttribute.cs (modified) (2 diffs)
• ValueAttribute.cs (modified) (2 diffs)

branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/Attributes/CommandAttribute.cs

@@ -1 +1 @@
 using System;
+using HeuristicLab.CommandLineInterface.Core;
 
 namespace HeuristicLab.CommandLineInterface {
@@ -7 +8 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Class)]
-  public class CommandAttribute : Attribute {
+  public class CommandAttribute : CLIBaseAttribute {
     /// <summary>
     /// To identify the command. This is the string, the user has to enter to activate this command.
@@ -17 +18 @@
     /// </summary>
     public Type[] SubCommands { get; set; } = new Type[0];
-    /// <summary>
-    /// Description for the command.
-    /// </summary>
-    public string Description { get; set; } = "";
   }
 }

branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/Attributes/OptionAttribute.cs

@@ -1 +1 @@
 using System;
+using HeuristicLab.CommandLineInterface.Core;
 
 namespace HeuristicLab.CommandLineInterface {
@@ -6 +7 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Property)]
-  public class OptionAttribute : Attribute {
+  public class OptionAttribute : CLIBaseAttribute {
     /// <summary>
     /// An optional shortcut of the option. Takes the '-' prefix. For example: '-o'.
     /// </summary>
     public string Shortcut { get; set; }
-    /// <summary>
-    /// The description of the option. 
-    /// </summary>
-    public string Description { get; set; }
     /// <summary>
     /// Set this to true to get a required option, which has always to be set from the user.

branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/Attributes/ValueAttribute.cs

@@ -1 +1 @@
 using System;
+using HeuristicLab.CommandLineInterface.Core;
 
 namespace HeuristicLab.CommandLineInterface {
@@ -6 +7 @@
   /// </summary>
   [AttributeUsage(AttributeTargets.Property)]
-  public class ValueAttribute : Attribute {
+  public class ValueAttribute : CLIBaseAttribute {
     /// <summary>
-    /// Description of the value.
+    /// The index of the value order. For example: a value with index=1 has to be 
+    /// specified before a value with index=2, else an exception will be thrown.
     /// </summary>
-    public string Description { get; set; }
-
     public int Index { get; set; }