|
0
|
1 <?xml version="1.0"?>
|
|
|
2 <doc>
|
|
|
3 <assembly>
|
|
|
4 <name>CommandLine</name>
|
|
|
5 </assembly>
|
|
|
6 <members>
|
|
|
7 <member name="T:CommandLine.CommandLineParserException">
|
|
|
8 <summary>
|
|
|
9 This exception is thrown when a generic parsing error occurs.
|
|
|
10 </summary>
|
|
|
11 </member>
|
|
|
12 <member name="T:CommandLine.ValueListAttribute">
|
|
|
13 <summary>
|
|
|
14 Models a list of command line arguments that are not options.
|
|
|
15 Must be applied to a field compatible with an <see cref="T:System.Collections.Generic.IList`1"/> interface
|
|
|
16 of <see cref="T:System.String"/> instances.
|
|
|
17 </summary>
|
|
|
18 </member>
|
|
|
19 <member name="M:CommandLine.ValueListAttribute.#ctor(System.Type)">
|
|
|
20 <summary>
|
|
|
21 Initializes a new instance of the <see cref="T:CommandLine.ValueListAttribute"/> class.
|
|
|
22 </summary>
|
|
|
23 <param name="concreteType">A type that implements <see cref="T:System.Collections.Generic.IList`1"/>.</param>
|
|
|
24 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="concreteType"/> is null.</exception>
|
|
|
25 </member>
|
|
|
26 <member name="P:CommandLine.ValueListAttribute.MaximumElements">
|
|
|
27 <summary>
|
|
|
28 Gets or sets the maximum element allow for the list managed by <see cref="T:CommandLine.ValueListAttribute"/> type.
|
|
|
29 If lesser than 0, no upper bound is fixed.
|
|
|
30 If equal to 0, no elements are allowed.
|
|
|
31 </summary>
|
|
|
32 </member>
|
|
|
33 <member name="T:CommandLine.HelpOptionAttribute">
|
|
|
34 <summary>
|
|
|
35 Indicates the instance method that must be invoked when it becomes necessary show your help screen.
|
|
|
36 The method signature is an instance method with no parameters and <see cref="T:System.String"/>
|
|
|
37 return value.
|
|
|
38 </summary>
|
|
|
39 </member>
|
|
|
40 <member name="T:CommandLine.BaseOptionAttribute">
|
|
|
41 <summary>
|
|
|
42 Provides base properties for creating an attribute, used to define rules for command line parsing.
|
|
|
43 </summary>
|
|
|
44 </member>
|
|
|
45 <member name="P:CommandLine.BaseOptionAttribute.ShortName">
|
|
|
46 <summary>
|
|
|
47 Short name of this command line option. You can use only one character.
|
|
|
48 </summary>
|
|
|
49 </member>
|
|
|
50 <member name="P:CommandLine.BaseOptionAttribute.LongName">
|
|
|
51 <summary>
|
|
|
52 Long name of this command line option. This name is usually a single english word.
|
|
|
53 </summary>
|
|
|
54 </member>
|
|
|
55 <member name="P:CommandLine.BaseOptionAttribute.Required">
|
|
|
56 <summary>
|
|
|
57 True if this command line option is required.
|
|
|
58 </summary>
|
|
|
59 </member>
|
|
|
60 <member name="P:CommandLine.BaseOptionAttribute.HelpText">
|
|
|
61 <summary>
|
|
|
62 A short description of this command line option. Usually a sentence summary.
|
|
|
63 </summary>
|
|
|
64 </member>
|
|
|
65 <member name="M:CommandLine.HelpOptionAttribute.#ctor">
|
|
|
66 <summary>
|
|
|
67 Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute"/> class.
|
|
|
68 </summary>
|
|
|
69 </member>
|
|
|
70 <member name="M:CommandLine.HelpOptionAttribute.#ctor(System.String,System.String)">
|
|
|
71 <summary>
|
|
|
72 Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute"/> class.
|
|
|
73 Allows you to define short and long option names.
|
|
|
74 </summary>
|
|
|
75 <param name="shortName">The short name of the option or null if not used.</param>
|
|
|
76 <param name="longName">The long name of the option or null if not used.</param>
|
|
|
77 </member>
|
|
|
78 <member name="P:CommandLine.HelpOptionAttribute.Required">
|
|
|
79 <summary>
|
|
|
80 Returns always false for this kind of option.
|
|
|
81 This behaviour can't be changed by design; if you try set <see cref="P:CommandLine.HelpOptionAttribute.Required"/>
|
|
|
82 an <see cref="T:System.InvalidOperationException"/> will be thrown.
|
|
|
83 </summary>
|
|
|
84 </member>
|
|
|
85 <member name="T:CommandLine.OptionAttribute">
|
|
|
86 <summary>
|
|
|
87 Models an option specification.
|
|
|
88 </summary>
|
|
|
89 </member>
|
|
|
90 <member name="M:CommandLine.OptionAttribute.#ctor(System.String,System.String)">
|
|
|
91 <summary>
|
|
|
92 Initializes a new instance of the <see cref="T:CommandLine.OptionAttribute"/> class.
|
|
|
93 </summary>
|
|
|
94 <param name="shortName">The short name of the option or null if not used.</param>
|
|
|
95 <param name="longName">The long name of the option or null if not used.</param>
|
|
|
96 </member>
|
|
|
97 <member name="P:CommandLine.OptionAttribute.MutuallyExclusiveSet">
|
|
|
98 <summary>
|
|
|
99 Gets or sets the option's mutually exclusive set.
|
|
|
100 </summary>
|
|
|
101 </member>
|
|
|
102 <member name="T:CommandLine.OptionListAttribute">
|
|
|
103 <summary>
|
|
|
104 Models an option that can accept multiple values.
|
|
|
105 Must be applied to a field compatible with an <see cref="T:System.Collections.Generic.IList`1"/> interface
|
|
|
106 of <see cref="T:System.String"/> instances.
|
|
|
107 </summary>
|
|
|
108 </member>
|
|
|
109 <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String)">
|
|
|
110 <summary>
|
|
|
111 Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute"/> class.
|
|
|
112 </summary>
|
|
|
113 <param name="shortName">The short name of the option or null if not used.</param>
|
|
|
114 <param name="longName">The long name of the option or null if not used.</param>
|
|
|
115 </member>
|
|
|
116 <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String,System.Char)">
|
|
|
117 <summary>
|
|
|
118 Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute"/> class.
|
|
|
119 </summary>
|
|
|
120 <param name="shortName">The short name of the option or null if not used.</param>
|
|
|
121 <param name="longName">The long name of the option or null if not used.</param>
|
|
|
122 <param name="separator">Values separator character.</param>
|
|
|
123 </member>
|
|
|
124 <member name="P:CommandLine.OptionListAttribute.Separator">
|
|
|
125 <summary>
|
|
|
126 Gets or sets the values separator character.
|
|
|
127 </summary>
|
|
|
128 </member>
|
|
|
129 <member name="T:CommandLine.Text.CopyrightInfo">
|
|
|
130 <summary>
|
|
|
131 Models the copyright informations part of an help text.
|
|
|
132 You can assign it where you assign any <see cref="T:System.String"/> instance.
|
|
|
133 </summary>
|
|
|
134 </member>
|
|
|
135 <member name="M:CommandLine.Text.CopyrightInfo.#ctor">
|
|
|
136 <summary>
|
|
|
137 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class.
|
|
|
138 </summary>
|
|
|
139 </member>
|
|
|
140 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32)">
|
|
|
141 <summary>
|
|
|
142 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
|
|
|
143 specifying author and year.
|
|
|
144 </summary>
|
|
|
145 <param name="author">The company or person holding the copyright.</param>
|
|
|
146 <param name="year">The year of coverage of copyright.</param>
|
|
|
147 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
|
|
|
148 </member>
|
|
|
149 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32[])">
|
|
|
150 <summary>
|
|
|
151 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
|
|
|
152 specifying author and years.
|
|
|
153 </summary>
|
|
|
154 <param name="author">The company or person holding the copyright.</param>
|
|
|
155 <param name="years">The years of coverage of copyright.</param>
|
|
|
156 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
|
|
|
157 <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years"/> is not supplied.</exception>
|
|
|
158 </member>
|
|
|
159 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.Boolean,System.String,System.Int32[])">
|
|
|
160 <summary>
|
|
|
161 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
|
|
|
162 specifying symbol case, author and years.
|
|
|
163 </summary>
|
|
|
164 <param name="isSymbolUpper">The case of the copyright symbol.</param>
|
|
|
165 <param name="author">The company or person holding the copyright.</param>
|
|
|
166 <param name="years">The years of coverage of copyright.</param>
|
|
|
167 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
|
|
|
168 <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years"/> is not supplied.</exception>
|
|
|
169 </member>
|
|
|
170 <member name="M:CommandLine.Text.CopyrightInfo.ToString">
|
|
|
171 <summary>
|
|
|
172 Returns the copyright informations as a <see cref="T:System.String"/>.
|
|
|
173 </summary>
|
|
|
174 <returns>The <see cref="T:System.String"/> that contains the copyright informations.</returns>
|
|
|
175 </member>
|
|
|
176 <member name="M:CommandLine.Text.CopyrightInfo.op_Implicit(CommandLine.Text.CopyrightInfo)~System.String">
|
|
|
177 <summary>
|
|
|
178 Converts the copyright informations to a <see cref="T:System.String"/>.
|
|
|
179 </summary>
|
|
|
180 <param name="info">This <see cref="T:CommandLine.Text.CopyrightInfo"/> instance.</param>
|
|
|
181 <returns>The <see cref="T:System.String"/> that contains the copyright informations.</returns>
|
|
|
182 </member>
|
|
|
183 <member name="M:CommandLine.Text.CopyrightInfo.FormatYears(System.Int32[])">
|
|
|
184 <summary>
|
|
|
185 When overridden in a derived class, allows to specify a new algorithm to render copyright years
|
|
|
186 as a <see cref="T:System.String"/> instance.
|
|
|
187 </summary>
|
|
|
188 <param name="years">A <see cref="T:System.Int32"/> array of years.</param>
|
|
|
189 <returns>A <see cref="T:System.String"/> instance with copyright years.</returns>
|
|
|
190 </member>
|
|
|
191 <member name="P:CommandLine.Text.CopyrightInfo.CopyrightWord">
|
|
|
192 <summary>
|
|
|
193 When overridden in a derived class, allows to specify a different copyright word.
|
|
|
194 </summary>
|
|
|
195 </member>
|
|
|
196 <member name="T:CommandLine.ICommandLineParser">
|
|
|
197 <summary>
|
|
|
198 Defines a basic interface to parse command line arguments.
|
|
|
199 </summary>
|
|
|
200 </member>
|
|
|
201 <member name="M:CommandLine.ICommandLineParser.ParseArguments(System.String[],System.Object)">
|
|
|
202 <summary>
|
|
|
203 Parses a <see cref="T:System.String"/> array of command line arguments, setting values in <paramref name="options"/>
|
|
|
204 parameter instance's public fields decorated with appropriate attributes.
|
|
|
205 </summary>
|
|
|
206 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
|
|
|
207 <param name="options">An object's instance used to receive values.
|
|
|
208 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
|
|
|
209 <returns>True if parsing process succeed.</returns>
|
|
|
210 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
|
|
|
211 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
|
|
|
212 </member>
|
|
|
213 <member name="M:CommandLine.ICommandLineParser.ParseArguments(System.String[],System.Object,System.IO.TextWriter)">
|
|
|
214 <summary>
|
|
|
215 Parses a <see cref="T:System.String"/> array of command line arguments, setting values in <paramref name="options"/>
|
|
|
216 parameter instance's public fields decorated with appropriate attributes.
|
|
|
217 This overload allows you to specify a <see cref="T:System.IO.TextWriter"/> derived instance for write text messages.
|
|
|
218 </summary>
|
|
|
219 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
|
|
|
220 <param name="options">An object's instance used to receive values.
|
|
|
221 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
|
|
|
222 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
|
|
|
223 usually <see cref="P:System.Console.Error"/>. Setting this argument to null, will disable help screen.</param>
|
|
|
224 <returns>True if parsing process succeed.</returns>
|
|
|
225 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
|
|
|
226 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
|
|
|
227 </member>
|
|
|
228 <member name="T:CommandLine.CommandLineParser">
|
|
|
229 <summary>
|
|
|
230 Provides methods to parse command line arguments.
|
|
|
231 Default implementation for <see cref="T:CommandLine.ICommandLineParser"/>.
|
|
|
232 </summary>
|
|
|
233 </member>
|
|
|
234 <member name="M:CommandLine.CommandLineParser.#ctor">
|
|
|
235 <summary>
|
|
|
236 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParser"/> class.
|
|
|
237 </summary>
|
|
|
238 </member>
|
|
|
239 <member name="M:CommandLine.CommandLineParser.#ctor(CommandLine.CommandLineParserSettings)">
|
|
|
240 <summary>
|
|
|
241 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParser"/> class,
|
|
|
242 configurable with a <see cref="T:CommandLine.CommandLineParserSettings"/> object.
|
|
|
243 </summary>
|
|
|
244 <param name="settings">The <see cref="T:CommandLine.CommandLineParserSettings"/> object is used to configure
|
|
|
245 aspects and behaviors of the parser.</param>
|
|
|
246 </member>
|
|
|
247 <member name="M:CommandLine.CommandLineParser.ParseArguments(System.String[],System.Object)">
|
|
|
248 <summary>
|
|
|
249 Parses a <see cref="T:System.String"/> array of command line arguments, setting values in <paramref name="options"/>
|
|
|
250 parameter instance's public fields decorated with appropriate attributes.
|
|
|
251 </summary>
|
|
|
252 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
|
|
|
253 <param name="options">An object's instance used to receive values.
|
|
|
254 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
|
|
|
255 <returns>True if parsing process succeed.</returns>
|
|
|
256 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
|
|
|
257 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
|
|
|
258 </member>
|
|
|
259 <member name="M:CommandLine.CommandLineParser.ParseArguments(System.String[],System.Object,System.IO.TextWriter)">
|
|
|
260 <summary>
|
|
|
261 Parses a <see cref="T:System.String"/> array of command line arguments, setting values in <paramref name="options"/>
|
|
|
262 parameter instance's public fields decorated with appropriate attributes.
|
|
|
263 This overload allows you to specify a <see cref="T:System.IO.TextWriter"/> derived instance for write text messages.
|
|
|
264 </summary>
|
|
|
265 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
|
|
|
266 <param name="options">An object's instance used to receive values.
|
|
|
267 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
|
|
|
268 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
|
|
|
269 usually <see cref="P:System.Console.Error"/>. Setting this argument to null, will disable help screen.</param>
|
|
|
270 <returns>True if parsing process succeed.</returns>
|
|
|
271 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
|
|
|
272 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
|
|
|
273 </member>
|
|
|
274 <member name="T:CommandLine.Text.HelpText">
|
|
|
275 <summary>
|
|
|
276 Models an help text and collects related informations.
|
|
|
277 You can assign it in place of a <see cref="T:System.String"/> instance.
|
|
|
278 </summary>
|
|
|
279 </member>
|
|
|
280 <member name="M:CommandLine.Text.HelpText.#ctor(System.String)">
|
|
|
281 <summary>
|
|
|
282 Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText"/> class
|
|
|
283 specifying heading informations.
|
|
|
284 </summary>
|
|
|
285 <param name="heading">A string with heading information or
|
|
|
286 an instance of <see cref="T:CommandLine.Text.HeadingInfo"/>.</param>
|
|
|
287 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="heading"/> is null or empty string.</exception>
|
|
|
288 </member>
|
|
|
289 <member name="M:CommandLine.Text.HelpText.AddPreOptionsLine(System.String)">
|
|
|
290 <summary>
|
|
|
291 Adds a text line after copyright and before options usage informations.
|
|
|
292 </summary>
|
|
|
293 <param name="value">A <see cref="T:System.String"/> instance.</param>
|
|
|
294 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="value"/> is null or empty string.</exception>
|
|
|
295 </member>
|
|
|
296 <member name="M:CommandLine.Text.HelpText.AddPostOptionsLine(System.String)">
|
|
|
297 <summary>
|
|
|
298 Adds a text line at the bottom, after options usage informations.
|
|
|
299 </summary>
|
|
|
300 <param name="value">A <see cref="T:System.String"/> instance.</param>
|
|
|
301 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="value"/> is null or empty string.</exception>
|
|
|
302 </member>
|
|
|
303 <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object)">
|
|
|
304 <summary>
|
|
|
305 Adds a text block with options usage informations.
|
|
|
306 </summary>
|
|
|
307 <param name="options">The instance that collected command line arguments parsed with <see cref="!:CommandLine.Parser"/> class.</param>
|
|
|
308 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options"/> is null.</exception>
|
|
|
309 </member>
|
|
|
310 <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object,System.String)">
|
|
|
311 <summary>
|
|
|
312 Adds a text block with options usage informations.
|
|
|
313 </summary>
|
|
|
314 <param name="options">The instance that collected command line arguments parsed with the <see cref="!:CommandLine.Parser"/> class.</param>
|
|
|
315 <param name="requiredWord">The word to use when the option is required.</param>
|
|
|
316 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options"/> is null.</exception>
|
|
|
317 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="requiredWord"/> is null or empty string.</exception>
|
|
|
318 </member>
|
|
|
319 <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object,System.String,System.Int32)">
|
|
|
320 <summary>
|
|
|
321 Adds a text block with options usage informations.
|
|
|
322 </summary>
|
|
|
323 <param name="options">The instance that collected command line arguments parsed with the <see cref="!:CommandLine.Parser"/> class.</param>
|
|
|
324 <param name="requiredWord">The word to use when the option is required.</param>
|
|
|
325 <param name="maximumLength">The maximum length of the help documentation.</param>
|
|
|
326 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options"/> is null.</exception>
|
|
|
327 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="requiredWord"/> is null or empty string.</exception>
|
|
|
328 </member>
|
|
|
329 <member name="M:CommandLine.Text.HelpText.ToString">
|
|
|
330 <summary>
|
|
|
331 Returns the help informations as a <see cref="T:System.String"/>.
|
|
|
332 </summary>
|
|
|
333 <returns>The <see cref="T:System.String"/> that contains the help informations.</returns>
|
|
|
334 </member>
|
|
|
335 <member name="M:CommandLine.Text.HelpText.op_Implicit(CommandLine.Text.HelpText)~System.String">
|
|
|
336 <summary>
|
|
|
337 Converts the help informations to a <see cref="T:System.String"/>.
|
|
|
338 </summary>
|
|
|
339 <param name="info">This <see cref="T:CommandLine.Text.HelpText"/> instance.</param>
|
|
|
340 <returns>The <see cref="T:System.String"/> that contains the help informations.</returns>
|
|
|
341 </member>
|
|
|
342 <member name="P:CommandLine.Text.HelpText.Copyright">
|
|
|
343 <summary>
|
|
|
344 Sets the copyright information string.
|
|
|
345 You can directly assign a <see cref="T:CommandLine.Text.CopyrightInfo"/> instance.
|
|
|
346 </summary>
|
|
|
347 </member>
|
|
|
348 <member name="P:CommandLine.Text.HelpText.MaximumDisplayWidth">
|
|
|
349 <summary>
|
|
|
350 Gets or sets the maximum width of the display. This determines word wrap when displaying the text.
|
|
|
351 </summary>
|
|
|
352 <value>The maximum width of the display.</value>
|
|
|
353 </member>
|
|
|
354 <member name="P:CommandLine.Text.HelpText.AdditionalNewLineAfterOption">
|
|
|
355 <summary>
|
|
|
356 Gets or sets whether to add an additional line after the description of the option.
|
|
|
357 </summary>
|
|
|
358 </member>
|
|
|
359 <member name="T:CommandLine.Text.HeadingInfo">
|
|
|
360 <summary>
|
|
|
361 Models the heading informations part of an help text.
|
|
|
362 You can assign it where you assign any <see cref="T:System.String"/> instance.
|
|
|
363 </summary>
|
|
|
364 </member>
|
|
|
365 <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String)">
|
|
|
366 <summary>
|
|
|
367 Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo"/> class
|
|
|
368 specifying program name.
|
|
|
369 </summary>
|
|
|
370 <param name="programName">The name of the program.</param>
|
|
|
371 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName"/> is null or empty string.</exception>
|
|
|
372 </member>
|
|
|
373 <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String,System.String)">
|
|
|
374 <summary>
|
|
|
375 Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo"/> class
|
|
|
376 specifying program name and version.
|
|
|
377 </summary>
|
|
|
378 <param name="programName">The name of the program.</param>
|
|
|
379 <param name="version">The version of the program.</param>
|
|
|
380 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName"/> is null or empty string.</exception>
|
|
|
381 </member>
|
|
|
382 <member name="M:CommandLine.Text.HeadingInfo.ToString">
|
|
|
383 <summary>
|
|
|
384 Returns the heading informations as a <see cref="T:System.String"/>.
|
|
|
385 </summary>
|
|
|
386 <returns>The <see cref="T:System.String"/> that contains the heading informations.</returns>
|
|
|
387 </member>
|
|
|
388 <member name="M:CommandLine.Text.HeadingInfo.op_Implicit(CommandLine.Text.HeadingInfo)~System.String">
|
|
|
389 <summary>
|
|
|
390 Converts the heading informations to a <see cref="T:System.String"/>.
|
|
|
391 </summary>
|
|
|
392 <param name="info">This <see cref="T:CommandLine.Text.HeadingInfo"/> instance.</param>
|
|
|
393 <returns>The <see cref="T:System.String"/> that contains the heading informations.</returns>
|
|
|
394 </member>
|
|
|
395 <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String,System.IO.TextWriter)">
|
|
|
396 <summary>
|
|
|
397 Writes out a string and a new line using the program name specified in the constructor
|
|
|
398 and <paramref name="message"/> parameter.
|
|
|
399 </summary>
|
|
|
400 <param name="message">The <see cref="T:System.String"/> message to write.</param>
|
|
|
401 <param name="writer">The target <see cref="T:System.IO.TextWriter"/> derived type.</param>
|
|
|
402 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
|
|
|
403 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="writer"/> is null.</exception>
|
|
|
404 </member>
|
|
|
405 <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String)">
|
|
|
406 <summary>
|
|
|
407 Writes out a string and a new line using the program name specified in the constructor
|
|
|
408 and <paramref name="message"/> parameter to standard output stream.
|
|
|
409 </summary>
|
|
|
410 <param name="message">The <see cref="T:System.String"/> message to write.</param>
|
|
|
411 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
|
|
|
412 </member>
|
|
|
413 <member name="M:CommandLine.Text.HeadingInfo.WriteError(System.String)">
|
|
|
414 <summary>
|
|
|
415 Writes out a string and a new line using the program name specified in the constructor
|
|
|
416 and <paramref name="message"/> parameter to standard error stream.
|
|
|
417 </summary>
|
|
|
418 <param name="message">The <see cref="T:System.String"/> message to write.</param>
|
|
|
419 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
|
|
|
420 </member>
|
|
|
421 <member name="T:CommandLine.OptionArrayAttribute">
|
|
|
422 <summary>
|
|
|
423 Models an option that can accept multiple values as separated arguments.
|
|
|
424 </summary>
|
|
|
425 </member>
|
|
|
426 <member name="M:CommandLine.OptionArrayAttribute.#ctor(System.String,System.String)">
|
|
|
427 <summary>
|
|
|
428 Initializes a new instance of the <see cref="T:CommandLine.OptionArrayAttribute"/> class.
|
|
|
429 </summary>
|
|
|
430 <param name="shortName">The short name of the option or null if not used.</param>
|
|
|
431 <param name="longName">The long name of the option or null if not used.</param>
|
|
|
432 </member>
|
|
|
433 <member name="T:CommandLine.CommandLineParserSettings">
|
|
|
434 <summary>
|
|
|
435 Specifies a set of features to configure a <see cref="T:CommandLine.CommandLineParser"/> behavior.
|
|
|
436 </summary>
|
|
|
437 </member>
|
|
|
438 <member name="M:CommandLine.CommandLineParserSettings.#ctor">
|
|
|
439 <summary>
|
|
|
440 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class.
|
|
|
441 </summary>
|
|
|
442 </member>
|
|
|
443 <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean)">
|
|
|
444 <summary>
|
|
|
445 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class,
|
|
|
446 setting the case comparison behavior.
|
|
|
447 </summary>
|
|
|
448 <param name="caseSensitive">If set to true, parsing will be case sensitive.</param>
|
|
|
449 </member>
|
|
|
450 <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.IO.TextWriter)">
|
|
|
451 <summary>
|
|
|
452 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class,
|
|
|
453 setting the <see cref="T:System.IO.TextWriter"/> used for help method output.
|
|
|
454 </summary>
|
|
|
455 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
|
|
|
456 default <see cref="P:System.Console.Error"/>. Setting this argument to null, will disable help screen.</param>
|
|
|
457 </member>
|
|
|
458 <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.IO.TextWriter)">
|
|
|
459 <summary>
|
|
|
460 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class,
|
|
|
461 setting case comparison and help output options.
|
|
|
462 </summary>
|
|
|
463 <param name="caseSensitive">If set to true, parsing will be case sensitive.</param>
|
|
|
464 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
|
|
|
465 default <see cref="P:System.Console.Error"/>. Setting this argument to null, will disable help screen.</param>
|
|
|
466 </member>
|
|
|
467 <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.Boolean)">
|
|
|
468 <summary>
|
|
|
469 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class,
|
|
|
470 setting case comparison and mutually exclusive behaviors.
|
|
|
471 </summary>
|
|
|
472 <param name="caseSensitive">If set to true, parsing will be case sensitive.</param>
|
|
|
473 <param name="mutuallyExclusive">If set to true, enable mutually exclusive behavior.</param>
|
|
|
474 </member>
|
|
|
475 <member name="M:CommandLine.CommandLineParserSettings.#ctor(System.Boolean,System.Boolean,System.IO.TextWriter)">
|
|
|
476 <summary>
|
|
|
477 Initializes a new instance of the <see cref="T:CommandLine.CommandLineParserSettings"/> class,
|
|
|
478 setting case comparison, mutually exclusive behavior and help output option.
|
|
|
479 </summary>
|
|
|
480 <param name="caseSensitive">If set to true, parsing will be case sensitive.</param>
|
|
|
481 <param name="mutuallyExclusive">If set to true, enable mutually exclusive behavior.</param>
|
|
|
482 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
|
|
|
483 default <see cref="P:System.Console.Error"/>. Setting this argument to null, will disable help screen.</param>
|
|
|
484 </member>
|
|
|
485 <member name="P:CommandLine.CommandLineParserSettings.CaseSensitive">
|
|
|
486 <summary>
|
|
|
487 Gets or sets the case comparison behavior.
|
|
|
488 Default is set to true.
|
|
|
489 </summary>
|
|
|
490 </member>
|
|
|
491 <member name="P:CommandLine.CommandLineParserSettings.MutuallyExclusive">
|
|
|
492 <summary>
|
|
|
493 Gets or sets the mutually exclusive behavior.
|
|
|
494 Default is set to false.
|
|
|
495 </summary>
|
|
|
496 </member>
|
|
|
497 <member name="P:CommandLine.CommandLineParserSettings.HelpWriter">
|
|
|
498 <summary>
|
|
|
499 Gets or sets the <see cref="T:System.IO.TextWriter"/> used for help method output.
|
|
|
500 Setting this property to null, will disable help screen.
|
|
|
501 </summary>
|
|
|
502 </member>
|
|
|
503 </members>
|
|
|
504 </doc>
|
