From aa60aeb86a369185e10df1761b03ace5a0c09641 Mon Sep 17 00:00:00 2001 From: Jarl Gullberg Date: Sun, 30 Jul 2017 18:57:18 +0200 Subject: [PATCH] Documented Options class in the converter. --- src/Generator.Converter/Options.cs | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/Generator.Converter/Options.cs b/src/Generator.Converter/Options.cs index eaf85a02..cbafa080 100644 --- a/src/Generator.Converter/Options.cs +++ b/src/Generator.Converter/Options.cs @@ -4,23 +4,38 @@ using CommandLine.Text; namespace OpenTK.Convert { + /// + /// A container class used by to parse command line arguments. + /// public class Options { + /// + /// Gets or sets the prefix to remove from parsed functions and constants. + /// [Option('p', "prefix", HelpText = "The prefix to remove from parsed functions and constants.", Required = true, Default = "gl")] public string Prefix { get; set; } + /// + /// Gets or sets the path to the output file. Defaults to stdout if no path is provided. + /// [Option('o', "output-file", HelpText = "The path to the output file. Defaults to stdout if no path is provided.")] public string OutputFile { get; set; } + /// + /// Gets or sets a list of the Khronos XML files to parse into OpenTK XML. Remote resources in the form of URLs are supported. + /// [Option('i', "input-files", HelpText = "A list of the Khronos XML files to parse into OpenTK XML. Remote resources in the form of URLs are supported.", Required = true)] public IEnumerable InputFiles { get; set; } + /// + /// Gets a set of usage examples which can be shown to the user. + /// [Usage(ApplicationAlias = "Convert.exe")] public static IEnumerable Examples {