Skip to content

Commit d801544

Browse files
iSazonovadityapatwardhan
authored andcommitted
Style: Change first char to upper in summary comments (#8597)
1 parent 8fad8c9 commit d801544

222 files changed

Lines changed: 1092 additions & 1092 deletions

File tree

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/CimAsyncOperation.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -547,12 +547,12 @@ private void Cleanup()
547547
#region private members
548548

549549
/// <summary>
550-
/// lock object.
550+
/// Lock object.
551551
/// </summary>
552552
private readonly object myLock = new object();
553553

554554
/// <summary>
555-
/// number of active operations.
555+
/// Number of active operations.
556556
/// </summary>
557557
private UInt32 operationCount = 0;
558558

@@ -569,12 +569,12 @@ private void Cleanup()
569569
private ConcurrentQueue<CimBaseAction> actionQueue;
570570

571571
/// <summary>
572-
/// lock object.
572+
/// Lock object.
573573
/// </summary>
574574
private readonly object cimSessionProxyCacheLock = new object();
575575

576576
/// <summary>
577-
/// cache all <see cref="CimSessionProxy"/> objects related to
577+
/// Cache all <see cref="CimSessionProxy"/> objects related to
578578
/// the current operation.
579579
/// </summary>
580580
private List<CimSessionProxy> cimSessionProxyCache;

src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -124,12 +124,12 @@ protected virtual void Block()
124124
#region members
125125

126126
/// <summary>
127-
/// action completed event.
127+
/// Action completed event.
128128
/// </summary>
129129
private ManualResetEventSlim completeEvent;
130130

131131
/// <summary>
132-
/// response result.
132+
/// Response result.
133133
/// </summary>
134134
protected CimResponseType responseType;
135135

src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
2525
internal class ParameterDefinitionEntry
2626
{
2727
/// <summary>
28-
/// constructor.
28+
/// Constructor.
2929
/// </summary>
3030
/// <param name="parameterSetName"></param>
3131
/// <param name="mandatory"></param>
@@ -36,7 +36,7 @@ internal ParameterDefinitionEntry(string parameterSetName, bool mandatory)
3636
}
3737

3838
/// <summary>
39-
/// property ParameterSetName.
39+
/// Property ParameterSetName.
4040
/// </summary>
4141
internal string ParameterSetName
4242
{
@@ -70,7 +70,7 @@ internal bool IsMandatory
7070
internal class ParameterSetEntry
7171
{
7272
/// <summary>
73-
/// constructor.
73+
/// Constructor.
7474
/// </summary>
7575
/// <param name="mandatoryParameterCount"></param>
7676
internal ParameterSetEntry(UInt32 mandatoryParameterCount)
@@ -81,7 +81,7 @@ internal ParameterSetEntry(UInt32 mandatoryParameterCount)
8181
}
8282

8383
/// <summary>
84-
/// constructor.
84+
/// Constructor.
8585
/// </summary>
8686
/// <param name="toClone"></param>
8787
internal ParameterSetEntry(ParameterSetEntry toClone)
@@ -92,7 +92,7 @@ internal ParameterSetEntry(ParameterSetEntry toClone)
9292
}
9393

9494
/// <summary>
95-
/// constructor.
95+
/// Constructor.
9696
/// </summary>
9797
/// <param name="mandatoryParameterCount"></param>
9898
/// <param name="mandatory"></param>
@@ -104,7 +104,7 @@ internal ParameterSetEntry(UInt32 mandatoryParameterCount, bool isDefault)
104104
}
105105

106106
/// <summary>
107-
/// reset the internal status.
107+
/// Reset the internal status.
108108
/// </summary>
109109
internal void reset()
110110
{
@@ -113,7 +113,7 @@ internal void reset()
113113
}
114114

115115
/// <summary>
116-
/// property <c>DefaultParameterSet</c>
116+
/// Property <c>DefaultParameterSet</c>
117117
/// </summary>
118118
internal bool IsDefaultParameterSet
119119
{
@@ -126,7 +126,7 @@ internal bool IsDefaultParameterSet
126126
private readonly bool isDefaultParameterSet = false;
127127

128128
/// <summary>
129-
/// property <c>MandatoryParameterCount</c>
129+
/// Property <c>MandatoryParameterCount</c>
130130
/// </summary>
131131
internal UInt32 MandatoryParameterCount
132132
{
@@ -139,7 +139,7 @@ internal UInt32 MandatoryParameterCount
139139
private readonly UInt32 mandatoryParameterCount = 0;
140140

141141
/// <summary>
142-
/// property <c>IsValueSet</c>
142+
/// Property <c>IsValueSet</c>
143143
/// </summary>
144144
internal bool IsValueSet
145145
{
@@ -157,7 +157,7 @@ internal bool IsValueSet
157157
private bool isValueSet = false;
158158

159159
/// <summary>
160-
/// property <c>IsValueSetAtBeginProcess</c>
160+
/// Property <c>IsValueSetAtBeginProcess</c>
161161
/// </summary>
162162
internal bool IsValueSetAtBeginProcess
163163
{
@@ -175,7 +175,7 @@ internal bool IsValueSetAtBeginProcess
175175
private bool isValueSetAtBeginProcess = false;
176176

177177
/// <summary>
178-
/// property <c>SetMandatoryParameterCount</c>
178+
/// Property <c>SetMandatoryParameterCount</c>
179179
/// </summary>
180180
internal UInt32 SetMandatoryParameterCount
181181
{
@@ -193,7 +193,7 @@ internal UInt32 SetMandatoryParameterCount
193193
private UInt32 setMandatoryParameterCount = 0;
194194

195195
/// <summary>
196-
/// property <c>SetMandatoryParameterCountAtBeginProcess</c>
196+
/// Property <c>SetMandatoryParameterCountAtBeginProcess</c>
197197
/// </summary>
198198
internal UInt32 SetMandatoryParameterCountAtBeginProcess
199199
{
@@ -217,7 +217,7 @@ internal UInt32 SetMandatoryParameterCountAtBeginProcess
217217
internal class ParameterBinder
218218
{
219219
/// <summary>
220-
/// constructor.
220+
/// Constructor.
221221
/// </summary>
222222
/// <param name="parameters"></param>
223223
/// <param name="sets"></param>
@@ -568,7 +568,7 @@ internal void SetParameter(object value, string parameterName)
568568
#region constructors
569569

570570
/// <summary>
571-
/// constructor.
571+
/// Constructor.
572572
/// </summary>
573573
internal CimBaseCommand()
574574
{
@@ -577,7 +577,7 @@ internal CimBaseCommand()
577577
}
578578

579579
/// <summary>
580-
/// constructor.
580+
/// Constructor.
581581
/// </summary>
582582
internal CimBaseCommand(Dictionary<string, HashSet<ParameterDefinitionEntry>> parameters,
583583
Dictionary<string, ParameterSetEntry> sets)
@@ -686,7 +686,7 @@ protected virtual void DisposeInternal()
686686
private CimAsyncOperation operation;
687687

688688
/// <summary>
689-
/// lock object.
689+
/// Lock object.
690690
/// </summary>
691691
private readonly object myLock = new object();
692692

@@ -780,37 +780,37 @@ internal void ThrowTerminatingError(Exception exception, string operation)
780780
#region internal const strings
781781

782782
/// <summary>
783-
/// alias CN - computer name.
783+
/// Alias CN - computer name.
784784
/// </summary>
785785
internal const string AliasCN = "CN";
786786

787787
/// <summary>
788-
/// alias ServerName - computer name.
788+
/// Alias ServerName - computer name.
789789
/// </summary>
790790
internal const string AliasServerName = "ServerName";
791791

792792
/// <summary>
793-
/// alias OT - operation timeout.
793+
/// Alias OT - operation timeout.
794794
/// </summary>
795795
internal const string AliasOT = "OT";
796796

797797
/// <summary>
798-
/// session set name.
798+
/// Session set name.
799799
/// </summary>
800800
internal const string SessionSetName = "SessionSet";
801801

802802
/// <summary>
803-
/// computer set name.
803+
/// Computer set name.
804804
/// </summary>
805805
internal const string ComputerSetName = "ComputerSet";
806806

807807
/// <summary>
808-
/// class name computer set name.
808+
/// Class name computer set name.
809809
/// </summary>
810810
internal const string ClassNameComputerSet = "ClassNameComputerSet";
811811

812812
/// <summary>
813-
/// resource Uri computer set name.
813+
/// Resource Uri computer set name.
814814
/// </summary>
815815
internal const string ResourceUriComputerSet = "ResourceUriComputerSet";
816816

@@ -820,17 +820,17 @@ internal void ThrowTerminatingError(Exception exception, string operation)
820820
internal const string CimInstanceComputerSet = "CimInstanceComputerSet";
821821

822822
/// <summary>
823-
/// query computer set name.
823+
/// Query computer set name.
824824
/// </summary>
825825
internal const string QueryComputerSet = "QueryComputerSet";
826826

827827
/// <summary>
828-
/// class name session set name.
828+
/// Class name session set name.
829829
/// </summary>
830830
internal const string ClassNameSessionSet = "ClassNameSessionSet";
831831

832832
/// <summary>
833-
/// resource Uri session set name.
833+
/// Resource Uri session set name.
834834
/// </summary>
835835
internal const string ResourceUriSessionSet = "ResourceUriSessionSet";
836836

@@ -840,7 +840,7 @@ internal void ThrowTerminatingError(Exception exception, string operation)
840840
internal const string CimInstanceSessionSet = "CimInstanceSessionSet";
841841

842842
/// <summary>
843-
/// query session set name.
843+
/// Query session set name.
844844
/// </summary>
845845
internal const string QuerySessionSet = "QuerySessionSet";
846846

@@ -872,12 +872,12 @@ internal void ThrowTerminatingError(Exception exception, string operation)
872872
#endregion
873873

874874
/// <summary>
875-
/// credential parameter set.
875+
/// Credential parameter set.
876876
/// </summary>
877877
internal const string CredentialParameterSet = "CredentialParameterSet";
878878

879879
/// <summary>
880-
/// certificate parameter set.
880+
/// Certificate parameter set.
881881
/// </summary>
882882
internal const string CertificateParameterSet = "CertificateParameterSet";
883883

src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
namespace Microsoft.Management.Infrastructure.CimCmdlets
1616
{
1717
/// <summary>
18-
/// a class used to add pstypename to partial ciminstance
18+
/// A class used to add pstypename to partial ciminstance
1919
/// for <see cref="GetCimInstanceCommand"/>, if -KeyOnly
2020
/// or -SelectProperties is been specified, then add a pstypename:
2121
/// "Microsoft.Management.Infrastructure.CimInstance#__PartialCIMInstance"
@@ -527,12 +527,12 @@ private void SetPreProcess(CimSessionProxy proxy, GetCimInstanceCommand cmdlet)
527527

528528
#region const strings
529529
/// <summary>
530-
/// wql query format with where clause.
530+
/// Wql query format with where clause.
531531
/// </summary>
532532
private const string queryWithWhere = @"SELECT {0} FROM {1} WHERE {2}";
533533

534534
/// <summary>
535-
/// wql query format without where clause.
535+
/// Wql query format without where clause.
536536
/// </summary>
537537
private const string queryWithoutWhere = @"SELECT {0} FROM {1}";
538538
#endregion

src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public CimIndicationEventInstanceEventArgs(CimSubscriptionResult result)
137137
public class CimIndicationWatcher
138138
{
139139
/// <summary>
140-
/// status of <see cref="CimIndicationWatcher"/> object.
140+
/// Status of <see cref="CimIndicationWatcher"/> object.
141141
/// </summary>
142142
internal enum Status
143143
{
@@ -364,12 +364,12 @@ internal void SetCmdlet(Cmdlet cmdlet)
364364
private CimRegisterCimIndication cimRegisterCimIndication;
365365

366366
/// <summary>
367-
/// the status of <see cref="CimIndicationWatcher"/> object.
367+
/// The status of <see cref="CimIndicationWatcher"/> object.
368368
/// </summary>
369369
private Status status;
370370

371371
/// <summary>
372-
/// lock started field.
372+
/// Lock started field.
373373
/// </summary>
374374
private object myLock;
375375

src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,12 +461,12 @@ private CimMethodParametersCollection CreateParametersCollection(
461461

462462
#region const strings
463463
/// <summary>
464-
/// operation target.
464+
/// Operation target.
465465
/// </summary>
466466
private const string targetClass = @"{0}";
467467

468468
/// <summary>
469-
/// action.
469+
/// Action.
470470
/// </summary>
471471
private const string actionTemplate = @"Invoke-CimMethod: {0}";
472472
#endregion

src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ private CimInstance CreateCimInstance(
362362

363363
#region const strings
364364
/// <summary>
365-
/// action.
365+
/// Action.
366366
/// </summary>
367367
private const string action = @"New-CimInstance";
368368
#endregion

src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public override void Execute(CmdletOperationBase cmdlet)
119119
#region members
120120

121121
/// <summary>
122-
/// prompt message.
122+
/// Prompt message.
123123
/// </summary>
124124
public string Message
125125
{
@@ -132,7 +132,7 @@ public string Message
132132
private string message;
133133

134134
/// <summary>
135-
/// prompt type -Normal or Critical.
135+
/// Prompt type -Normal or Critical.
136136
/// </summary>
137137
private CimPromptType prompt;
138138

src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ private void CimIndicationHandler(object cimSession, CmdletActionEventArgs actio
271271
}
272272

273273
/// <summary>
274-
/// block the ps thread until ACK message or Error happened.
274+
/// Block the ps thread until ACK message or Error happened.
275275
/// </summary>
276276
private void WaitForAckMessage()
277277
{
@@ -315,7 +315,7 @@ internal Cmdlet Cmdlet
315315
}
316316

317317
/// <summary>
318-
/// target computername.
318+
/// Target computername.
319319
/// </summary>
320320
internal string TargetComputerName
321321
{

src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ internal void RemoveCimInstance(CimInstance cimInstance, XOperationContextBase c
143143

144144
#region const strings
145145
/// <summary>
146-
/// action.
146+
/// Action.
147147
/// </summary>
148148
private const string action = @"Remove-CimInstance";
149149
#endregion

0 commit comments

Comments
 (0)