Skip to content

Style: Change first char to upper in summary comments #8597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adityapatwardhan merged 6 commits into from
Jan 9, 2019
Merged

Style: Change first char to upper in summary comments #8597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8353ab4
Remove extra space
iSazonov Jan 6, 2019
b52eae9
Commit 1
iSazonov Jan 6, 2019
a58dd1e
Commit 2
iSazonov Jan 6, 2019
723ff79
Commit 3
iSazonov Jan 6, 2019
18f0a88
Commit 4
iSazonov Jan 6, 2019
b3e0945
Commit 5
iSazonov Jan 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimAsyncOperation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,12 +547,12 @@ private void Cleanup()
#region private members

/// <summary>
/// lock object.
/// Lock object.
/// </summary>
private readonly object myLock = new object();

/// <summary>
/// number of active operations.
/// Number of active operations.
/// </summary>
private UInt32 operationCount = 0;

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

/// <summary>
/// lock object.
/// Lock object.
/// </summary>
private readonly object cimSessionProxyCacheLock = new object();

/// <summary>
/// cache all <see cref="CimSessionProxy"/> objects related to
/// Cache all <see cref="CimSessionProxy"/> objects related to
/// the current operation.
/// </summary>
private List<CimSessionProxy> cimSessionProxyCache;
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,12 +124,12 @@ protected virtual void Block()
#region members

/// <summary>
/// action completed event.
/// Action completed event.
/// </summary>
private ManualResetEventSlim completeEvent;

/// <summary>
/// response result.
/// Response result.
/// </summary>
protected CimResponseType responseType;

Expand Down
58 changes: 29 additions & 29 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimCommandBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace Microsoft.Management.Infrastructure.CimCmdlets
internal class ParameterDefinitionEntry
{
/// <summary>
/// constructor.
/// Constructor.
/// </summary>
/// <param name="parameterSetName"></param>
/// <param name="mandatory"></param>
Expand All @@ -36,7 +36,7 @@ internal ParameterDefinitionEntry(string parameterSetName, bool mandatory)
}

/// <summary>
/// property ParameterSetName.
/// Property ParameterSetName.
/// </summary>
internal string ParameterSetName
{
Expand Down Expand Up @@ -70,7 +70,7 @@ internal bool IsMandatory
internal class ParameterSetEntry
{
/// <summary>
/// constructor.
/// Constructor.
/// </summary>
/// <param name="mandatoryParameterCount"></param>
internal ParameterSetEntry(UInt32 mandatoryParameterCount)
Expand All @@ -81,7 +81,7 @@ internal ParameterSetEntry(UInt32 mandatoryParameterCount)
}

/// <summary>
/// constructor.
/// Constructor.
/// </summary>
/// <param name="toClone"></param>
internal ParameterSetEntry(ParameterSetEntry toClone)
Expand All @@ -92,7 +92,7 @@ internal ParameterSetEntry(ParameterSetEntry toClone)
}

/// <summary>
/// constructor.
/// Constructor.
/// </summary>
/// <param name="mandatoryParameterCount"></param>
/// <param name="mandatory"></param>
Expand All @@ -104,7 +104,7 @@ internal ParameterSetEntry(UInt32 mandatoryParameterCount, bool isDefault)
}

/// <summary>
/// reset the internal status.
/// Reset the internal status.
/// </summary>
internal void reset()
{
Expand All @@ -113,7 +113,7 @@ internal void reset()
}

/// <summary>
/// property <c>DefaultParameterSet</c>
/// Property <c>DefaultParameterSet</c>
/// </summary>
internal bool IsDefaultParameterSet
{
Expand All @@ -126,7 +126,7 @@ internal bool IsDefaultParameterSet
private readonly bool isDefaultParameterSet = false;

/// <summary>
/// property <c>MandatoryParameterCount</c>
/// Property <c>MandatoryParameterCount</c>
/// </summary>
internal UInt32 MandatoryParameterCount
{
Expand All @@ -139,7 +139,7 @@ internal UInt32 MandatoryParameterCount
private readonly UInt32 mandatoryParameterCount = 0;

/// <summary>
/// property <c>IsValueSet</c>
/// Property <c>IsValueSet</c>
/// </summary>
internal bool IsValueSet
{
Expand All @@ -157,7 +157,7 @@ internal bool IsValueSet
private bool isValueSet = false;

/// <summary>
/// property <c>IsValueSetAtBeginProcess</c>
/// Property <c>IsValueSetAtBeginProcess</c>
/// </summary>
internal bool IsValueSetAtBeginProcess
{
Expand All @@ -175,7 +175,7 @@ internal bool IsValueSetAtBeginProcess
private bool isValueSetAtBeginProcess = false;

/// <summary>
/// property <c>SetMandatoryParameterCount</c>
/// Property <c>SetMandatoryParameterCount</c>
/// </summary>
internal UInt32 SetMandatoryParameterCount
{
Expand All @@ -193,7 +193,7 @@ internal UInt32 SetMandatoryParameterCount
private UInt32 setMandatoryParameterCount = 0;

/// <summary>
/// property <c>SetMandatoryParameterCountAtBeginProcess</c>
/// Property <c>SetMandatoryParameterCountAtBeginProcess</c>
/// </summary>
internal UInt32 SetMandatoryParameterCountAtBeginProcess
{
Expand All @@ -217,7 +217,7 @@ internal UInt32 SetMandatoryParameterCountAtBeginProcess
internal class ParameterBinder
{
/// <summary>
/// constructor.
/// Constructor.
/// </summary>
/// <param name="parameters"></param>
/// <param name="sets"></param>
Expand Down Expand Up @@ -568,7 +568,7 @@ internal void SetParameter(object value, string parameterName)
#region constructors

/// <summary>
/// constructor.
/// Constructor.
/// </summary>
internal CimBaseCommand()
{
Expand All @@ -577,7 +577,7 @@ internal CimBaseCommand()
}

/// <summary>
/// constructor.
/// Constructor.
/// </summary>
internal CimBaseCommand(Dictionary<string, HashSet<ParameterDefinitionEntry>> parameters,
Dictionary<string, ParameterSetEntry> sets)
Expand Down Expand Up @@ -686,7 +686,7 @@ protected virtual void DisposeInternal()
private CimAsyncOperation operation;

/// <summary>
/// lock object.
/// Lock object.
/// </summary>
private readonly object myLock = new object();

Expand Down Expand Up @@ -780,37 +780,37 @@ internal void ThrowTerminatingError(Exception exception, string operation)
#region internal const strings

/// <summary>
/// alias CN - computer name.
/// Alias CN - computer name.
/// </summary>
internal const string AliasCN = "CN";

/// <summary>
/// alias ServerName - computer name.
/// Alias ServerName - computer name.
/// </summary>
internal const string AliasServerName = "ServerName";

/// <summary>
/// alias OT - operation timeout.
/// Alias OT - operation timeout.
/// </summary>
internal const string AliasOT = "OT";

/// <summary>
/// session set name.
/// Session set name.
/// </summary>
internal const string SessionSetName = "SessionSet";

/// <summary>
/// computer set name.
/// Computer set name.
/// </summary>
internal const string ComputerSetName = "ComputerSet";

/// <summary>
/// class name computer set name.
/// Class name computer set name.
/// </summary>
internal const string ClassNameComputerSet = "ClassNameComputerSet";

/// <summary>
/// resource Uri computer set name.
/// Resource Uri computer set name.
/// </summary>
internal const string ResourceUriComputerSet = "ResourceUriComputerSet";

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

/// <summary>
/// query computer set name.
/// Query computer set name.
/// </summary>
internal const string QueryComputerSet = "QueryComputerSet";

/// <summary>
/// class name session set name.
/// Class name session set name.
/// </summary>
internal const string ClassNameSessionSet = "ClassNameSessionSet";

/// <summary>
/// resource Uri session set name.
/// Resource Uri session set name.
/// </summary>
internal const string ResourceUriSessionSet = "ResourceUriSessionSet";

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

/// <summary>
/// query session set name.
/// Query session set name.
/// </summary>
internal const string QuerySessionSet = "QuerySessionSet";

Expand Down Expand Up @@ -872,12 +872,12 @@ internal void ThrowTerminatingError(Exception exception, string operation)
#endregion

/// <summary>
/// credential parameter set.
/// Credential parameter set.
/// </summary>
internal const string CredentialParameterSet = "CredentialParameterSet";

/// <summary>
/// certificate parameter set.
/// Certificate parameter set.
/// </summary>
internal const string CertificateParameterSet = "CertificateParameterSet";

Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
namespace Microsoft.Management.Infrastructure.CimCmdlets
{
/// <summary>
/// a class used to add pstypename to partial ciminstance
/// A class used to add pstypename to partial ciminstance
/// for <see cref="GetCimInstanceCommand"/>, if -KeyOnly
/// or -SelectProperties is been specified, then add a pstypename:
/// "Microsoft.Management.Infrastructure.CimInstance#__PartialCIMInstance"
Expand Down Expand Up @@ -527,12 +527,12 @@ private void SetPreProcess(CimSessionProxy proxy, GetCimInstanceCommand cmdlet)

#region const strings
/// <summary>
/// wql query format with where clause.
/// Wql query format with where clause.
/// </summary>
private const string queryWithWhere = @"SELECT {0} FROM {1} WHERE {2}";

/// <summary>
/// wql query format without where clause.
/// Wql query format without where clause.
/// </summary>
private const string queryWithoutWhere = @"SELECT {0} FROM {1}";
#endregion
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimIndicationWatcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ public CimIndicationEventInstanceEventArgs(CimSubscriptionResult result)
public class CimIndicationWatcher
{
/// <summary>
/// status of <see cref="CimIndicationWatcher"/> object.
/// Status of <see cref="CimIndicationWatcher"/> object.
/// </summary>
internal enum Status
{
Expand Down Expand Up @@ -364,12 +364,12 @@ internal void SetCmdlet(Cmdlet cmdlet)
private CimRegisterCimIndication cimRegisterCimIndication;

/// <summary>
/// the status of <see cref="CimIndicationWatcher"/> object.
/// The status of <see cref="CimIndicationWatcher"/> object.
/// </summary>
private Status status;

/// <summary>
/// lock started field.
/// Lock started field.
/// </summary>
private object myLock;

Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimInvokeCimMethod.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,12 +461,12 @@ private CimMethodParametersCollection CreateParametersCollection(

#region const strings
/// <summary>
/// operation target.
/// Operation target.
/// </summary>
private const string targetClass = @"{0}";

/// <summary>
/// action.
/// Action.
/// </summary>
private const string actionTemplate = @"Invoke-CimMethod: {0}";
#endregion
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ private CimInstance CreateCimInstance(

#region const strings
/// <summary>
/// action.
/// Action.
/// </summary>
private const string action = @"New-CimInstance";
#endregion
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimPromptUser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ public override void Execute(CmdletOperationBase cmdlet)
#region members

/// <summary>
/// prompt message.
/// Prompt message.
/// </summary>
public string Message
{
Expand All @@ -132,7 +132,7 @@ public string Message
private string message;

/// <summary>
/// prompt type -Normal or Critical.
/// Prompt type -Normal or Critical.
/// </summary>
private CimPromptType prompt;

Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimRegisterCimIndication.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ private void CimIndicationHandler(object cimSession, CmdletActionEventArgs actio
}

/// <summary>
/// block the ps thread until ACK message or Error happened.
/// Block the ps thread until ACK message or Error happened.
/// </summary>
private void WaitForAckMessage()
{
Expand Down Expand Up @@ -315,7 +315,7 @@ internal Cmdlet Cmdlet
}

/// <summary>
/// target computername.
/// Target computername.
/// </summary>
internal String TargetComputerName
{
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimRemoveCimInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ internal void RemoveCimInstance(CimInstance cimInstance, XOperationContextBase c

#region const strings
/// <summary>
/// action.
/// Action.
/// </summary>
private const string action = @"Remove-CimInstance";
#endregion
Expand Down
Loading