@joebigelow / wix-1
Code Commits Issues Pulls Sessions CI/CD
main
main
cs 52 lines 1.93 KB
Raw
1 // Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information.
2
3 namespace WixToolset.Extensibility.Data
4 {
5 using System.Collections.Generic;
6
7 /// <summary>
8 /// A command line option (switch or command) description.
9 /// </summary>
10 public class CommandLineHelp
11 {
12 /// <summary>
13 /// Creates command line help.
14 /// </summary>
15 /// <param name="description">Description for the command line option.</param>
16 /// <param name="usage">Optional usage for the command line option.</param>
17 /// <param name="switches">Optional list of switches.</param>
18 /// <param name="commands">Optional list of commands.</param>
19 public CommandLineHelp(string description, string usage = null, IReadOnlyCollection<CommandLineHelpSwitch> switches = null, IReadOnlyCollection<CommandLineHelpCommand> commands = null)
20 {
21 this.Description = description;
22 this.Usage = usage;
23 this.Switches = switches;
24 this.Commands = commands;
25 }
26
27 /// <summary>
28 /// Description for the command line option.
29 /// </summary>
30 public string Description { get; set; }
31
32 /// <summary>
33 /// Usage for the command line option.
34 /// </summary>
35 public string Usage { get; set; }
36
37 /// <summary>
38 /// Optional additional notes for the command line option.
39 /// </summary>
40 public string Notes { get; set; }
41
42 /// <summary>
43 /// Optional list of command line switches.
44 /// </summary>
45 public IReadOnlyCollection<CommandLineHelpSwitch> Switches { get; set; }
46
47 /// <summary>
48 /// Optional list of command line commands.
49 /// </summary>
50 public IReadOnlyCollection<CommandLineHelpCommand> Commands { get; set; }
51 }
52 }