Add xml docs based on HelpText

This commit is contained in:
VperuS 2017-11-18 18:24:46 +02:00
parent 781cdd5a3b
commit 376f3edfd7

View file

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