From 376f3edfd71bc140db20f55bc5562797bf540474 Mon Sep 17 00:00:00 2001 From: VperuS Date: Sat, 18 Nov 2017 18:24:46 +0200 Subject: [PATCH 1/3] Add xml docs based on HelpText --- src/Generator.Rewrite/Options.cs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/Generator.Rewrite/Options.cs b/src/Generator.Rewrite/Options.cs index eca85326..e325d61a 100644 --- a/src/Generator.Rewrite/Options.cs +++ b/src/Generator.Rewrite/Options.cs @@ -3,20 +3,35 @@ using CommandLine.Text; namespace OpenTK.Rewrite { + /// + /// A container class used by to parse command line arguments. + /// public class Options { + /// + /// Set the path to the target assembly that should be rewritten. + /// [Option('a', "assembly", Required = true, HelpText = "The path to the target assembly that should be rewritten.")] public string TargetAssembly { get; set; } + /// + /// Set the path to the strong name key which should be used to sign or resign the assembly. + /// [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; } + /// + /// Enable calls to GL.GetError(), wrapped around each native call. + /// [Option('d', "debug", Default = false, HelpText = "Enable calls to GL.GetError(), wrapped around each native call.")] public bool EnableDebugCalls { get; set; } + /// + /// Force native calls to use DllImport instead of GetProcAddress. + /// [Option("dllimport", Default = false, HelpText = "Force native calls to use DllImport instead of GetProcAddress.")] public bool UseDLLImport { get; set; } From 24b09303814591dc5dacbba3547c76610b4e4cdb Mon Sep 17 00:00:00 2001 From: VperuS Date: Mon, 20 Nov 2017 06:14:44 +0200 Subject: [PATCH 2/3] Apply required changes --- src/Generator.Rewrite/Options.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/Generator.Rewrite/Options.cs b/src/Generator.Rewrite/Options.cs index e325d61a..4aeca6c1 100644 --- a/src/Generator.Rewrite/Options.cs +++ b/src/Generator.Rewrite/Options.cs @@ -9,31 +9,31 @@ namespace OpenTK.Rewrite public class Options { /// - /// Set the path to the target assembly that should be rewritten. + /// Gets or sets the path to the target assembly that should be rewritten. /// [Option('a', "assembly", Required = true, HelpText = "The path to the target assembly that should be rewritten.")] public string TargetAssembly { get; set; } /// - /// Set the path to the strong name key which should be used to sign or resign the assembly. + /// Get or sets the path to the strong name key which should be used to sign or resign the assembly. /// [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; } /// - /// Enable calls to GL.GetError(), wrapped around each native call. + /// Gets or sets a value indicating whether enable calls to GL.GetError(), wrapped around each native call. /// [Option('d', "debug", Default = false, HelpText = "Enable calls to GL.GetError(), wrapped around each native call.")] public bool EnableDebugCalls { get; set; } /// - /// Force native calls to use DllImport instead of GetProcAddress. + /// Gets or sets a value indicating whether force native calls to use DllImport instead of GetProcAddress. /// [Option("dllimport", Default = false, HelpText = "Force native calls to use DllImport instead of GetProcAddress.")] public bool UseDLLImport { get; set; } } -} \ No newline at end of file +} From ce86006c8e973df6162f07fc69fcae0936d90dbe Mon Sep 17 00:00:00 2001 From: VperuS Date: Tue, 21 Nov 2017 01:40:51 +0200 Subject: [PATCH 3/3] English grammar in comments --- src/Generator.Rewrite/Options.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Generator.Rewrite/Options.cs b/src/Generator.Rewrite/Options.cs index 4aeca6c1..155a3abd 100644 --- a/src/Generator.Rewrite/Options.cs +++ b/src/Generator.Rewrite/Options.cs @@ -23,14 +23,14 @@ namespace OpenTK.Rewrite public string StrongNameKey { get; set; } /// - /// Gets or sets a value indicating whether enable calls to GL.GetError(), wrapped around each native call. + /// Gets or sets a value indicating whether calls to GL.GetError() are wrapped around each native call. /// [Option('d', "debug", Default = false, HelpText = "Enable calls to GL.GetError(), wrapped around each native call.")] public bool EnableDebugCalls { get; set; } /// - /// Gets or sets a value indicating whether force native calls to use DllImport instead of GetProcAddress. + /// Gets or sets a value indicating whether native calls are forced to use DllImport instead of GetProcAddress. /// [Option("dllimport", Default = false, HelpText = "Force native calls to use DllImport instead of GetProcAddress.")]