added comments

mookid8000 · mookid8000 · commit d9597b8bdb97 · 2016-02-10T22:34:22.000+01:00
diff --git a/GoCommando/BannerAttribute.cs b/GoCommando/BannerAttribute.cs
@@ -8,8 +8,14 @@ namespace GoCommando
     [AttributeUsage(AttributeTargets.Class)]
     public class BannerAttribute : Attribute
     {
+        /// <summary>
+        /// Gets the banner text
+        /// </summary>
         public string BannerText { get; }
 
+        /// <summary>
+        /// Constructs the attribute
+        /// </summary>
         public BannerAttribute(string bannerText)
         {
             BannerText = bannerText;
diff --git a/GoCommando/CommandAttribute.cs b/GoCommando/CommandAttribute.cs
@@ -2,11 +2,20 @@
 
 namespace GoCommando
 {
+    /// <summary>
+    /// Attribute that can be applied to a class that represents a command. The class must implement <see cref="ICommand"/>
+    /// </summary>
     [AttributeUsage(AttributeTargets.Class)]
     public class CommandAttribute : Attribute
     {
+        /// <summary>
+        /// Gets the name of the command
+        /// </summary>
         public string Command { get; }
 
+        /// <summary>
+        /// Constructs the attribute
+        /// </summary>
         public CommandAttribute(string command)
         {
             Command = command;
diff --git a/GoCommando/DescriptionAttribute.cs b/GoCommando/DescriptionAttribute.cs
@@ -9,8 +9,14 @@ namespace GoCommando
     [AttributeUsage(AttributeTargets.Property | AttributeTargets.Class)]
     public class DescriptionAttribute : Attribute
     {
+        /// <summary>
+        /// Gets the description text
+        /// </summary>
         public string DescriptionText { get; }
 
+        /// <summary>
+        /// Constructs the attribute
+        /// </summary>
         public DescriptionAttribute(string descriptionText)
         {
             DescriptionText = descriptionText;
diff --git a/GoCommando/ExampleAttribute.cs b/GoCommando/ExampleAttribute.cs
@@ -8,8 +8,14 @@ namespace GoCommando
     [AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]
     public class ExampleAttribute : Attribute
     {
+        /// <summary>
+        /// Gets the example text
+        /// </summary>
         public string ExampleValue { get; }
 
+        /// <summary>
+        /// Constructs the attribute
+        /// </summary>
         public ExampleAttribute(string exampleValue)
         {
             ExampleValue = exampleValue;
diff --git a/GoCommando/ExitCodeException.cs b/GoCommando/ExitCodeException.cs
@@ -9,15 +9,24 @@ namespace GoCommando
     [Serializable]
     public class CustomExitCodeException : Exception
     {
+        /// <summary>
+        /// Constructs the exception
+        /// </summary>
         protected CustomExitCodeException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }
 
+        /// <summary>
+        /// Constructs the exception
+        /// </summary>
         public CustomExitCodeException(int exitCode, string message) : base(message)
         {
             ExitCode = exitCode;
         }
 
+        /// <summary>
+        /// Gets the exit code that the program must exit with
+        /// </summary>
         public int ExitCode { get; }
     }
 }
diff --git a/GoCommando/GoCommandoException.cs b/GoCommando/GoCommandoException.cs
@@ -10,10 +10,16 @@ namespace GoCommando
     [Serializable]
     public class GoCommandoException : Exception
     {
+        /// <summary>
+        /// Constructs the exception
+        /// </summary>
         protected GoCommandoException(SerializationInfo info, StreamingContext context) : base(info, context)
         {
         }
 
+        /// <summary>
+        /// Constructs the exception
+        /// </summary>
         public GoCommandoException(string message) : base(message)
         {
         }
diff --git a/GoCommando/ICommand.cs b/GoCommando/ICommand.cs
@@ -5,6 +5,9 @@
     /// </summary>
     public interface ICommand
     {
+        /// <summary>
+        /// Main run method that is invoked by GoCommando
+        /// </summary>
         void Run();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,14 @@ namespace GoCommando`
`8`	`8`	`[AttributeUsage(AttributeTargets.Class)]`
`9`	`9`	`public class BannerAttribute : Attribute`
`10`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// Gets the banner text`
	`13`	`+ /// </summary>`
`11`	`14`	`public string BannerText { get; }`
`12`	`15`
	`16`	`+ /// <summary>`
	`17`	`+ /// Constructs the attribute`
	`18`	`+ /// </summary>`
`13`	`19`	`public BannerAttribute(string bannerText)`
`14`	`20`	`{`
`15`	`21`	`BannerText = bannerText;`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,20 @@`
`2`	`2`
`3`	`3`	`namespace GoCommando`
`4`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// Attribute that can be applied to a class that represents a command. The class must implement <see cref="ICommand"/>`
	`7`	`+ /// </summary>`
`5`	`8`	`[AttributeUsage(AttributeTargets.Class)]`
`6`	`9`	`public class CommandAttribute : Attribute`
`7`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// Gets the name of the command`
	`13`	`+ /// </summary>`
`8`	`14`	`public string Command { get; }`
`9`	`15`
	`16`	`+ /// <summary>`
	`17`	`+ /// Constructs the attribute`
	`18`	`+ /// </summary>`
`10`	`19`	`public CommandAttribute(string command)`
`11`	`20`	`{`
`12`	`21`	`Command = command;`
Original file line number	Diff line number	Diff line change
`@@ -9,8 +9,14 @@ namespace GoCommando`
`9`	`9`	`[AttributeUsage(AttributeTargets.Property \| AttributeTargets.Class)]`
`10`	`10`	`public class DescriptionAttribute : Attribute`
`11`	`11`	`{`
	`12`	`+ /// <summary>`
	`13`	`+ /// Gets the description text`
	`14`	`+ /// </summary>`
`12`	`15`	`public string DescriptionText { get; }`
`13`	`16`
	`17`	`+ /// <summary>`
	`18`	`+ /// Constructs the attribute`
	`19`	`+ /// </summary>`
`14`	`20`	`public DescriptionAttribute(string descriptionText)`
`15`	`21`	`{`
`16`	`22`	`DescriptionText = descriptionText;`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,14 @@ namespace GoCommando`
`8`	`8`	`[AttributeUsage(AttributeTargets.Property, AllowMultiple = true)]`
`9`	`9`	`public class ExampleAttribute : Attribute`
`10`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// Gets the example text`
	`13`	`+ /// </summary>`
`11`	`14`	`public string ExampleValue { get; }`
`12`	`15`
	`16`	`+ /// <summary>`
	`17`	`+ /// Constructs the attribute`
	`18`	`+ /// </summary>`
`13`	`19`	`public ExampleAttribute(string exampleValue)`
`14`	`20`	`{`
`15`	`21`	`ExampleValue = exampleValue;`
Original file line number	Diff line number	Diff line change
`@@ -9,15 +9,24 @@ namespace GoCommando`
`9`	`9`	`[Serializable]`
`10`	`10`	`public class CustomExitCodeException : Exception`
`11`	`11`	`{`
	`12`	`+ /// <summary>`
	`13`	`+ /// Constructs the exception`
	`14`	`+ /// </summary>`
`12`	`15`	`protected CustomExitCodeException(SerializationInfo info, StreamingContext context) : base(info, context)`
`13`	`16`	`{`
`14`	`17`	`}`
`15`	`18`
	`19`	`+ /// <summary>`
	`20`	`+ /// Constructs the exception`
	`21`	`+ /// </summary>`
`16`	`22`	`public CustomExitCodeException(int exitCode, string message) : base(message)`
`17`	`23`	`{`
`18`	`24`	`ExitCode = exitCode;`
`19`	`25`	`}`
`20`	`26`
	`27`	`+ /// <summary>`
	`28`	`+ /// Gets the exit code that the program must exit with`
	`29`	`+ /// </summary>`
`21`	`30`	`public int ExitCode { get; }`
`22`	`31`	`}`
`23`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,16 @@ namespace GoCommando`
`10`	`10`	`[Serializable]`
`11`	`11`	`public class GoCommandoException : Exception`
`12`	`12`	`{`
	`13`	`+ /// <summary>`
	`14`	`+ /// Constructs the exception`
	`15`	`+ /// </summary>`
`13`	`16`	`protected GoCommandoException(SerializationInfo info, StreamingContext context) : base(info, context)`
`14`	`17`	`{`
`15`	`18`	`}`
`16`	`19`
	`20`	`+ /// <summary>`
	`21`	`+ /// Constructs the exception`
	`22`	`+ /// </summary>`
`17`	`23`	`public GoCommandoException(string message) : base(message)`
`18`	`24`	`{`
`19`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`	`/// </summary>`
`6`	`6`	`public interface ICommand`
`7`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// Main run method that is invoked by GoCommando`
	`10`	`+ /// </summary>`
`8`	`11`	`void Run();`
`9`	`12`	`}`
`10`	`13`	`}`