Merge pull request #681 from VPeruS/missing-xml

Add xml docs based on HelpText
This commit is contained in:
varon 2017-12-06 16:51:48 +02:00 committed by GitHub
commit 81268371c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View 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>
/// Gets or sets 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>
/// Get or sets 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>
/// Gets or sets a value indicating whether calls to GL.GetError() are 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>
/// Gets or sets a value indicating whether native calls are forced 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; }