Skip to content

Commit 00ef543

Browse files
Doc commments for ParameterizedSwitchInfo (#8644)
These comments were hidden where they didn't helpfully show when I was adding a new `ParameterizedSwitchInfo`.
1 parent 5fbc295 commit 00ef543

File tree

1 file changed

+10
-18
lines changed

1 file changed

+10
-18
lines changed

src/MSBuild/CommandLineSwitches.cs

Lines changed: 10 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Licensed to the .NET Foundation under one or more agreements.
1+
// Licensed to the .NET Foundation under one or more agreements.
22
// The .NET Foundation licenses this file to you under the MIT license.
33

44
using System;
@@ -151,12 +151,15 @@ private struct ParameterizedSwitchInfo
151151
/// <summary>
152152
/// Initializes struct data.
153153
/// </summary>
154-
/// <param name="switchNames"></param>
155-
/// <param name="parameterizedSwitch"></param>
156-
/// <param name="duplicateSwitchErrorMessage"></param>
157-
/// <param name="multipleParametersAllowed"></param>
158-
/// <param name="missingParametersErrorMessage"></param>
159-
/// <param name="unquoteParameters"></param>
154+
/// <param name="switchNames">Names of the switch (without leading switch indicator).</param>
155+
/// <param name="parameterizedSwitch">The switch id.</param>
156+
/// <param name="duplicateSwitchErrorMessage">If <see langword="null"/>, indicates that switch is allowed to appear multiple times on the command line; otherwise, holds the error message to display if switch appears more than once</param>
157+
/// <param name="multipleParametersAllowed">Indicates if switch can take multiple parameters (equivalent to switch appearing multiple times on command line)
158+
/// NOTE: for most switches, if a switch is allowed to appear multiple times on the command line, then multiple
159+
/// parameters can be provided per switch; however, some switches cannot take multiple parameters.</param>
160+
/// <param name="missingParametersErrorMessage">If <see langword="null"/>, indicates that switch is allowed to have no parameters; otherwise, holds the error message to show if switch is found without parameters on the command line</param>
161+
/// <param name="unquoteParameters">Indicates if quotes should be removed from the switch parameters</param>
162+
/// <param name="emptyParametersAllowed">Indicates if empty parameters are allowed and if so an empty string will be added to the list of parameter values.</param>
160163
internal ParameterizedSwitchInfo(
161164
string[] switchNames,
162165
ParameterizedSwitch parameterizedSwitch,
@@ -175,23 +178,12 @@ internal ParameterizedSwitchInfo(
175178
this.emptyParametersAllowed = emptyParametersAllowed;
176179
}
177180

178-
// names of the switch (without leading switch indicator)
179181
internal string[] switchNames;
180-
// if null, indicates that switch is allowed to appear multiple times on the command line; otherwise, holds the error
181-
// message to display if switch appears more than once
182182
internal string duplicateSwitchErrorMessage;
183-
// indicates if switch can take multiple parameters (equivalent to switch appearing multiple times on command line)
184-
// NOTE: for most switches, if a switch is allowed to appear multiple times on the command line, then multiple
185-
// parameters can be provided per switch; however, some switches cannot take multiple parameters
186183
internal bool multipleParametersAllowed;
187-
// if null, indicates that switch is allowed to have no parameters; otherwise, holds the error message to show if
188-
// switch is found without parameters on the command line
189184
internal string missingParametersErrorMessage;
190-
// indicates if quotes should be removed from the switch parameters
191185
internal bool unquoteParameters;
192-
// the switch id
193186
internal ParameterizedSwitch parameterizedSwitch;
194-
// indicates if empty parameters are allowed and if so an empty string will be added to the list of parameter values
195187
internal bool emptyParametersAllowed;
196188
}
197189

0 commit comments

Comments
 (0)