Skip to content

Commit 4f57804

Browse files
JamesWTruherJamesWTruher
authored
Fix up all comments to be in the proper order with proper spacing (#18619)
1 parent f04940b commit 4f57804

52 files changed

Lines changed: 237 additions & 235 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionProxy.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2154,12 +2154,11 @@ internal class CimSessionProxyNewCimInstance : CimSessionProxy
21542154

21552155
/// <summary>
21562156
/// Initializes a new instance of the <see cref="CimSessionProxyNewCimInstance"/> class.
2157-
/// <summary>
2157+
/// </summary>
21582158
/// <remarks>
21592159
/// Create <see cref="CimSession"/> by given computer name.
21602160
/// Then create wrapper object.
21612161
/// </remarks>
2162-
/// <param name="computerName"></param>
21632162
public CimSessionProxyNewCimInstance(string computerName, CimNewCimInstance operation)
21642163
: base(computerName)
21652164
{
@@ -2169,6 +2168,7 @@ public CimSessionProxyNewCimInstance(string computerName, CimNewCimInstance oper
21692168
/// <summary>
21702169
/// Initializes a new instance of the <see cref="CimSessionProxyNewCimInstance"/> class.
21712170
/// </summary>
2171+
/// <param name="computerName"></param>
21722172
/// <remarks>
21732173
/// Create <see cref="CimSession"/> by given computer name
21742174
/// and session options.

‎src/Microsoft.PowerShell.Commands.Management/commands/management/GetComputerInfoCommand.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3325,9 +3325,9 @@ public enum AdminPasswordStatus
33253325
[SuppressMessage("Microsoft.Design", "CA1008:EnumsShouldHaveZeroValue", Justification = "The underlying MOF definition does not contain a zero value. The converter method will handle it appropriately.")]
33263326
public enum BootOptionAction
33273327
{
3328-
// <summary>
3329-
// This value is reserved
3330-
// </summary>
3328+
// <summary>
3329+
// This value is reserved
3330+
// </summary>
33313331
// Reserved = 0,
33323332

33333333
/// <summary>

‎src/Microsoft.PowerShell.Commands.Management/commands/management/Process.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -528,18 +528,18 @@ public SwitchParameter IncludeUserName
528528

529529
private bool _includeUserName = false;
530530

531-
///<summary>
531+
/// <summary>
532532
/// To display the modules of a process.
533-
///</summary>
533+
/// </summary>
534534
[Parameter(ParameterSetName = NameParameterSet)]
535535
[Parameter(ParameterSetName = IdParameterSet)]
536536
[Parameter(ParameterSetName = InputObjectParameterSet)]
537537
[ValidateNotNull]
538538
public SwitchParameter Module { get; set; }
539539

540-
///<summary>
540+
/// <summary>
541541
/// To display the fileversioninfo of the main module of a process.
542-
///</summary>
542+
/// </summary>
543543
[Parameter(ParameterSetName = NameParameterSet)]
544544
[Parameter(ParameterSetName = IdParameterSet)]
545545
[Parameter(ParameterSetName = InputObjectParameterSet)]

‎src/Microsoft.PowerShell.Commands.Management/commands/management/Service.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2955,20 +2955,20 @@ internal static ServiceStartupType GetServiceStartupType(ServiceStartMode startM
29552955
#endregion NativeMethods
29562956

29572957
#region ServiceStartupType
2958-
///<summary>
2959-
///Enum for usage with StartupType. Automatic, Manual and Disabled index matched from System.ServiceProcess.ServiceStartMode
2960-
///</summary>
2958+
/// <summary>
2959+
/// Enum for usage with StartupType. Automatic, Manual and Disabled index matched from System.ServiceProcess.ServiceStartMode
2960+
/// </summary>
29612961
public enum ServiceStartupType
29622962
{
2963-
///<summary>Invalid service</summary>
2963+
/// <summary>Invalid service</summary>
29642964
InvalidValue = -1,
2965-
///<summary>Automatic service</summary>
2965+
/// <summary>Automatic service</summary>
29662966
Automatic = 2,
2967-
///<summary>Manual service</summary>
2967+
/// <summary>Manual service</summary>
29682968
Manual = 3,
2969-
///<summary>Disabled service</summary>
2969+
/// <summary>Disabled service</summary>
29702970
Disabled = 4,
2971-
///<summary>Automatic (Delayed Start) service</summary>
2971+
/// <summary>Automatic (Delayed Start) service</summary>
29722972
AutomaticDelayedStart = 10
29732973
}
29742974
#endregion ServiceStartupType

‎src/Microsoft.PowerShell.Commands.Management/commands/management/WMIHelper.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,9 @@ internal void RaiseOperationCompleteEvent(EventArgs baseEventArgs, OperationStat
182182
OperationComplete.SafeInvoke(this, operationStateEventArgs);
183183
}
184184

185-
///<summary>
185+
/// <summary>
186186
/// Raise WMI state changed event
187-
///</summary>
187+
/// </summary>
188188
internal void RaiseWmiOperationState(EventArgs baseEventArgs, WmiState state)
189189
{
190190
WmiJobStateEventArgs wmiJobStateEventArgs = new WmiJobStateEventArgs();
@@ -992,16 +992,16 @@ private void ConnectGetWMI()
992992
}
993993
}
994994

995-
///<summary>
995+
/// <summary>
996996
/// Event which will be triggered when WMI state is changed.
997997
/// Currently it is to notify Jobs that state has changed to running.
998998
/// Other states are notified via OperationComplete.
999-
///</summary>
999+
/// </summary>
10001000
internal sealed class WmiJobStateEventArgs : EventArgs
10011001
{
1002-
///<summary>
1002+
/// <summary>
10031003
/// WMI state
1004-
///</summary>
1004+
/// </summary>
10051005
internal WmiState WmiState { get; set; }
10061006
}
10071007

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/CsvCommands.cs‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ public abstract class BaseCsvWritingCommand : PSCmdlet
3232
[ValidateNotNull]
3333
public char Delimiter { get; set; }
3434

35-
///<summary>
36-
///Culture switch for csv conversion
37-
///</summary>
35+
/// <summary>
36+
/// Culture switch for csv conversion
37+
/// </summary>
3838
[Parameter(ParameterSetName = "UseCulture")]
3939
public SwitchParameter UseCulture { get; set; }
4040

@@ -586,9 +586,9 @@ public string[] LiteralPath
586586
[ValidateNotNull]
587587
public SwitchParameter UseCulture { get; set; }
588588

589-
///<summary>
589+
/// <summary>
590590
/// Gets or sets header property to customize the names.
591-
///</summary>
591+
/// </summary>
592592
[Parameter(Mandatory = false)]
593593
[ValidateNotNullOrEmpty]
594594
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
@@ -785,9 +785,9 @@ public sealed class ConvertFromCsvCommand : PSCmdlet
785785
[ValidateNotNullOrEmpty]
786786
public char Delimiter { get; set; }
787787

788-
///<summary>
789-
///Culture switch for csv conversion
790-
///</summary>
788+
/// <summary>
789+
/// Culture switch for csv conversion
790+
/// </summary>
791791
[Parameter(ParameterSetName = "UseCulture", Mandatory = true)]
792792
[ValidateNotNull]
793793
[ValidateNotNullOrEmpty]
@@ -802,9 +802,9 @@ public sealed class ConvertFromCsvCommand : PSCmdlet
802802
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
803803
public PSObject[] InputObject { get; set; }
804804

805-
///<summary>
805+
/// <summary>
806806
/// Gets or sets header property to customize the names.
807-
///</summary>
807+
/// </summary>
808808
[Parameter(Mandatory = false)]
809809
[ValidateNotNull]
810810
[ValidateNotNullOrEmpty]

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/Get-PSBreakpoint.cs‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ public enum BreakpointType
1616
/// <summary>Breakpoint on a line within a script</summary>
1717
Line,
1818

19-
/// <summary>
20-
/// Breakpoint on a variable</summary>
19+
/// <summary>Breakpoint on a variable</summary>
2120
Variable,
2221

2322
/// <summary>Breakpoint on a command</summary>

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/ObjectCommandComparer.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ internal int Compare(ObjectCommandPropertyValue first, ObjectCommandPropertyValu
190190
/// </param>
191191
/// <returns>
192192
/// 0 if they are the same, less than 0 if first is smaller, more than 0 if first is greater.
193-
///</returns>
193+
/// </returns>
194194
public int Compare(object first, object second)
195195
{
196196
// This method will never throw exceptions, two null

‎src/Microsoft.PowerShell.Commands.Utility/commands/utility/XmlCommands.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -803,9 +803,9 @@ internal void Import()
803803
}
804804

805805
#region Select-Xml
806-
///<summary>
807-
///This cmdlet is used to search an xml document based on the XPath Query.
808-
///</summary>
806+
/// <summary>
807+
/// This cmdlet is used to search an xml document based on the XPath Query.
808+
/// </summary>
809809
[Cmdlet(VerbsCommon.Select, "Xml", DefaultParameterSetName = "Xml", HelpUri = "https://go.microsoft.com/fwlink/?LinkID=2097031")]
810810
[OutputType(typeof(SelectXmlInfo))]
811811
public class SelectXmlCommand : PSCmdlet

‎src/Microsoft.PowerShell.ConsoleHost/host/msh/ConsoleHost.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ private static bool BreakIntoDebugger()
431431
/// if true, then flag the parent ConsoleHost that it should shutdown the session. If false, then only the current
432432
/// executing instance is stopped.
433433
///
434-
///</param>
434+
/// </param>
435435
private static void SpinUpBreakHandlerThread(bool shouldEndSession)
436436
{
437437
ConsoleHost host = ConsoleHost.SingletonInstance;

0 commit comments

Comments
 (0)