Add xml docs based on HelpText
authorVperuS <vperus@gmail.com>
Sat, 18 Nov 2017 16:24:46 +0000 (18:24 +0200)
committerVperuS <vperus@gmail.com>
Sat, 18 Nov 2017 16:45:42 +0000 (18:45 +0200)
src/Generator.Rewrite/Options.cs

index eca8532..e325d61 100644 (file)
@@ -3,20 +3,35 @@ using CommandLine.Text;
 
 namespace OpenTK.Rewrite
 {
+    /// <summary>
+    /// A container class used by <see cref="CommandLine.Parser"/> to parse command line arguments.
+    /// </summary>
     public class Options
     {
+        /// <summary>
+        /// Set the path to the target assembly that should be rewritten.
+        /// </summary>
         [Option('a', "assembly", Required = true,
             HelpText = "The path to the target assembly that should be rewritten.")]
         public string TargetAssembly { get; set; }
 
+        /// <summary>
+        /// Set the path to the strong name key which should be used to sign or resign the assembly.
+        /// </summary>
         [Option('k', "signing-key",
             HelpText = "The path to the strong name key which should be used to sign or resign the assembly.")]
         public string StrongNameKey { get; set; }
 
+        /// <summary>
+        /// Enable calls to GL.GetError(), wrapped around each native call.
+        /// </summary>
         [Option('d', "debug", Default = false,
             HelpText = "Enable calls to GL.GetError(), wrapped around each native call.")]
         public bool EnableDebugCalls { get; set; }
 
+        /// <summary>
+        /// Force native calls to use DllImport instead of GetProcAddress.
+        /// </summary>
         [Option("dllimport", Default = false,
             HelpText = "Force native calls to use DllImport instead of GetProcAddress.")]
         public bool UseDLLImport { get; set; }