ryujinx/Opentk
1
0
Fork 0
mirror of https://github.com/Ryujinx/Opentk.git synced 2025-07-03 11:28:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documented Options class in the converter.

Browse source
This commit is contained in:
Jarl Gullberg 2017-07-30 18:57:18 +02:00
parent 7c85903456
commit aa60aeb86a
No known key found for this signature in database
GPG key ID: 750FF6F6BDA72D23
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/Generator.Converter/Options.cs
View file

@ -4,23 +4,38 @@ using CommandLine.Text;
namespace OpenTK.Convert namespace OpenTK.Convert
{ {
/// <summary>
/// A container class used by <see cref="CommandLine.Parser"/> to parse command line arguments.
/// </summary>
public class Options public class Options
{ {
/// <summary>
/// Gets or sets the prefix to remove from parsed functions and constants.
/// </summary>
[Option('p', "prefix", [Option('p', "prefix",
HelpText = "The prefix to remove from parsed functions and constants.", HelpText = "The prefix to remove from parsed functions and constants.",
Required = true, Required = true,
Default = "gl")] Default = "gl")]
public string Prefix { get; set; } public string Prefix { get; set; }
/// <summary>
/// Gets or sets the path to the output file. Defaults to stdout if no path is provided.
/// </summary>
[Option('o', "output-file", [Option('o', "output-file",
HelpText = "The path to the output file. Defaults to stdout if no path is provided.")] HelpText = "The path to the output file. Defaults to stdout if no path is provided.")]
public string OutputFile { get; set; } public string OutputFile { get; set; }
/// <summary>
/// Gets or sets a list of the Khronos XML files to parse into OpenTK XML. Remote resources in the form of URLs are supported.
/// </summary>
[Option('i', "input-files", [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.", HelpText = "A list of the Khronos XML files to parse into OpenTK XML. Remote resources in the form of URLs are supported.",
Required = true)] Required = true)]
public IEnumerable<string> InputFiles { get; set; } public IEnumerable<string> InputFiles { get; set; }
/// <summary>
/// Gets a set of usage examples which can be shown to the user.
/// </summary>
[Usage(ApplicationAlias = "Convert.exe")] [Usage(ApplicationAlias = "Convert.exe")]
public static IEnumerable<Example> Examples public static IEnumerable<Example> Examples
{ {