Skip to content

Style: Add period before </param> and </exception> doc tags #8553

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
iSazonov merged 13 commits into from
Dec 28, 2018
Merged

Style: Add period before </param> and </exception> doc tags #8553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
8d7b3d4
Commit 1
iSazonov Dec 28, 2018
4b6aa7a
Commit 2
iSazonov Dec 28, 2018
61ab1c6
Commit 3
iSazonov Dec 28, 2018
cd0f449
Commit 4
iSazonov Dec 28, 2018
c31de56
Commit 5
iSazonov Dec 28, 2018
5870974
Commit 6
iSazonov Dec 28, 2018
dca5b8e
Commit 7
iSazonov Dec 28, 2018
cb2900d
Commit 8
iSazonov Dec 28, 2018
e734865
Commit 9
iSazonov Dec 28, 2018
ff5acf9
Fix one style issue SA1625
iSazonov Dec 28, 2018
7ea319f
Remove extra period
iSazonov Dec 28, 2018
002519d
Remove extra period 2
iSazonov Dec 28, 2018
cf44ece
Additional cleanup
iSazonov Dec 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 8 additions & 8 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 @@ -50,7 +50,7 @@ public CimAsyncOperation()
/// <param name="cimSession">
/// <seealso cref="CimSession"/> object raised the event
/// </param>
/// <param name="actionArgs">event argument</param>
/// <param name="actionArgs">event argument.</param>
protected void NewCmdletActionHandler(object cimSession, CmdletActionEventArgs actionArgs)
{
DebugHelper.WriteLogEx("Disposed {0}, action type = {1}", 0, this._disposed, actionArgs.Action);
Expand Down Expand Up @@ -83,7 +83,7 @@ protected void NewCmdletActionHandler(object cimSession, CmdletActionEventArgs a
/// <param name="cimSession">
/// <seealso cref="CimSession"/> object raised the event
/// </param>
/// <param name="actionArgs">event argument</param>
/// <param name="actionArgs">event argument.</param>
protected void OperationCreatedHandler(object cimSession, OperationEventArgs actionArgs)
{
DebugHelper.WriteLogEx();
Expand All @@ -103,7 +103,7 @@ protected void OperationCreatedHandler(object cimSession, OperationEventArgs act
/// <param name="cimSession">
/// <seealso cref="CimSession"/> object raised the event
/// </param>
/// <param name="actionArgs">event argument</param>
/// <param name="actionArgs">event argument.</param>
protected void OperationDeletedHandler(object cimSession, OperationEventArgs actionArgs)
{
DebugHelper.WriteLogEx();
Expand Down Expand Up @@ -190,7 +190,7 @@ public void ProcessRemainActions(CmdletOperationBase cmdletOperation)
/// Get action object from action queue
/// </para>
/// </summary>
/// <param name="action">next action to execute</param>
/// <param name="action">next action to execute.</param>
/// <returns>True indicates there is an valid action, otherwise false.</returns>
protected bool GetActionAndRemove(out CimBaseAction action)
{
Expand All @@ -202,8 +202,8 @@ protected bool GetActionAndRemove(out CimBaseAction action)
/// Add temporary <seealso cref="CimSessionProxy"/> object to cache.
/// </para>
/// </summary>
/// <param name="computerName">Computer name of the cimsession</param>
/// <param name="sessionproxy">cimsession wrapper object</param>
/// <param name="computerName">Computer name of the cimsession.</param>
/// <param name="sessionproxy">cimsession wrapper object.</param>
protected void AddCimSessionProxy(CimSessionProxy sessionproxy)
{
lock (cimSessionProxyCacheLock)
Expand Down Expand Up @@ -382,7 +382,7 @@ protected object GetBaseObject(object value)
/// if not thrown exception.
/// </summary>
/// <param name="value"></param>
/// <param name="referenceType">output the cimtype of the value, either Reference or ReferenceArray</param>
/// <param name="referenceType">output the cimtype of the value, either Reference or ReferenceArray.</param>
/// <returns></returns>
protected object GetReferenceOrReferenceArrayObject(object value, ref CimType referenceType)
{
Expand Down Expand Up @@ -480,7 +480,7 @@ public void Dispose()
/// other objects. Only unmanaged resources can be disposed.
/// </para>
/// </summary>
/// <param name="disposing">Whether it is directly called</param>
/// <param name="disposing">Whether it is directly called.</param>
protected virtual void Dispose(bool disposing)
{
if (Interlocked.CompareExchange(ref this._disposed, 1, 0) == 0)
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimBaseAction.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public void Dispose()
/// other objects. Only unmanaged resources can be disposed.
/// </para>
/// </summary>
/// <param name="disposing">Whether it is directly called</param>
/// <param name="disposing">Whether it is directly called.</param>
protected virtual void Dispose(bool disposing)
{
// Check to see if Dispose has already been called.
Expand Down
4 changes: 2 additions & 2 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 @@ -310,7 +310,7 @@ internal void reset()
/// </para>
/// </summary>
/// <param name="parameterName"></param>
/// <exception cref="PSArgumentException">throw if conflict parameter was set</exception>
/// <exception cref="PSArgumentException">throw if conflict parameter was set.</exception>
internal void SetParameter(string parameterName, bool isBeginProcess)
{
DebugHelper.WriteLogEx("ParameterName = {0}, isBeginProcess = {1}", 0, parameterName, isBeginProcess);
Expand Down Expand Up @@ -635,7 +635,7 @@ public void Dispose()
/// other objects. Only unmanaged resources can be disposed.
/// </para>
/// </summary>
/// <param name="disposing">Whether it is directly called</param>
/// <param name="disposing">Whether it is directly called.</param>
protected void Dispose(bool disposing)
{
// Check to see if Dispose has already been called.
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetAssociatedInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public CimGetAssociatedInstance()
/// Base on parametersetName to retrieve associated ciminstances
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object.</param>
public void GetCimAssociatedInstance(GetCimAssociatedInstanceCommand cmdlet)
{
IEnumerable<string> computerNames = ConstValue.GetComputerNames(cmdlet.ComputerName);
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetCimClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public CimGetCimClass()
/// Base on parametersetName to retrieve <see cref="CimClass"/>
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimClassCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimClassCommand"/> object.</param>
public void GetCimClass(GetCimClassCommand cmdlet)
{
List<CimSessionProxy> proxys = new List<CimSessionProxy>();
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Management.Infrastructure.CimCmdlets/CimGetInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public CimGetInstance() : base()
/// Base on parametersetName to retrieve ciminstances
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object.</param>
public void GetCimInstance(GetCimInstanceCommand cmdlet)
{
GetCimInstanceInternal(cmdlet);
Expand Down
6 changes: 3 additions & 3 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 @@ -88,7 +88,7 @@ public CimInvokeCimMethod()
/// Base on parametersetName to retrieve ciminstances
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object.</param>
public void InvokeCimMethod(InvokeCimMethodCommand cmdlet)
{
IEnumerable<string> computerNames = ConstValue.GetComputerNames(cmdlet.ComputerName);
Expand Down Expand Up @@ -348,8 +348,8 @@ private CimSessionProxy CreateSessionProxy(
/// <param name="cimInstance"></param>
/// <param name="methodName"></param>
/// <returns></returns>
/// <exception cref="ArgumentNullException">See CimProperty.Create</exception>
/// <exception cref="ArgumentException">CimProperty.Create</exception>
/// <exception cref="ArgumentNullException">See CimProperty.Create.</exception>
/// <exception cref="ArgumentException">CimProperty.Create.</exception>
private CimMethodParametersCollection CreateParametersCollection(
IDictionary parameters,
CimClass cimClass,
Expand Down
10 changes: 5 additions & 5 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimNewCimInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public CimNewCimInstance()
/// either remotely or locally
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object.</param>
public void NewCimInstance(NewCimInstanceCommand cmdlet)
{
DebugHelper.WriteLogEx();
Expand Down Expand Up @@ -261,8 +261,8 @@ private CimSessionProxy CreateSessionProxy(
/// <param name="properties"></param>
/// <param name="cmdlet"></param>
/// <returns></returns>
/// <exception cref="ArgumentNullException">See CimProperty.Create</exception>
/// <exception cref="ArgumentException">CimProperty.Create</exception>
/// <exception cref="ArgumentNullException">See CimProperty.Create.</exception>
/// <exception cref="ArgumentException">CimProperty.Create.</exception>
private CimInstance CreateCimInstance(
string className,
string cimNamespace,
Expand Down Expand Up @@ -328,8 +328,8 @@ private CimInstance CreateCimInstance(
/// <param name="properties"></param>
/// <param name="cmdlet"></param>
/// <returns></returns>
/// <exception cref="ArgumentNullException">See CimProperty.Create</exception>
/// <exception cref="ArgumentException">CimProperty.Create</exception>
/// <exception cref="ArgumentNullException">See CimProperty.Create.</exception>
/// <exception cref="ArgumentException">CimProperty.Create.</exception>
private CimInstance CreateCimInstance(
CimClass cimClass,
IDictionary properties,
Expand Down
8 changes: 4 additions & 4 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 @@ -132,7 +132,7 @@ public CimRegisterCimIndication()
/// <summary>
/// Start an indication subscription target to the given computer.
/// </summary>
/// <param name="computerName">null stands for localhost</param>
/// <param name="computerName">null stands for localhost.</param>
/// <param name="nameSpace"></param>
/// <param name="queryDialect"></param>
/// <param name="queryExpression"></param>
Expand All @@ -154,12 +154,12 @@ public void RegisterCimIndication(
/// <summary>
/// Start an indication subscription through a given <see cref="CimSession"/>.
/// </summary>
/// <param name="cimSession">Cannot be null</param>
/// <param name="cimSession">Cannot be null.</param>
/// <param name="nameSpace"></param>
/// <param name="queryDialect"></param>
/// <param name="queryExpression"></param>
/// <param name="operationTimeout"></param>
/// <exception cref="ArgumentNullException">throw if cimSession is null</exception>
/// <exception cref="ArgumentNullException">throw if cimSession is null.</exception>
public void RegisterCimIndication(
CimSession cimSession,
string nameSpace,
Expand Down Expand Up @@ -206,7 +206,7 @@ protected override void SubscribeToCimSessionProxyEvent(CimSessionProxy proxy)
/// <param name="cimSession">
/// <seealso cref="CimSession"/> object raised the event
/// </param>
/// <param name="actionArgs">event argument</param>
/// <param name="actionArgs">event argument.</param>
private void CimIndicationHandler(object cimSession, CmdletActionEventArgs actionArgs)
{
DebugHelper.WriteLogEx("action is {0}. Disposed {1}", 0, actionArgs.Action, this.Disposed);
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 @@ -55,7 +55,7 @@ public CimRemoveCimInstance()
/// Base on parametersetName to retrieve ciminstances
/// </para>
/// </summary>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object</param>
/// <param name="cmdlet"><see cref="GetCimInstanceCommand"/> object.</param>
public void RemoveCimInstance(RemoveCimInstanceCommand cmdlet)
{
DebugHelper.WriteLogEx();
Expand Down
18 changes: 9 additions & 9 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimResultObserver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ internal class AsyncResultCompleteEventArgs : AsyncResultEventArgsBase
/// Constructor
/// </para>
/// </summary>
/// <param name="session"><see cref="CimSession"/> object</param>
/// <param name="session"><see cref="CimSession"/> object.</param>
/// <param name="cancellationDisposable"></param>
public AsyncResultCompleteEventArgs(
CimSession session,
Expand Down Expand Up @@ -220,8 +220,8 @@ internal class CimResultObserver<T> : IObserver<T>
/// Define delegate that handles new cmdlet action come from
/// the operations related to the current CimSession object.
/// </summary>
/// <param name="cimSession">cimSession object, which raised the event</param>
/// <param name="actionArgs">Event args</param>
/// <param name="cimSession">cimSession object, which raised the event.</param>
/// <param name="actionArgs">Event args.</param>
public delegate void ResultEventHandler(
object observer,
AsyncResultEventArgsBase resultArgs);
Expand All @@ -234,8 +234,8 @@ public delegate void ResultEventHandler(
/// <summary>
/// Constructor
/// </summary>
/// <param name="session"><see cref="CimSession"/> object that issued the operation</param>
/// <param name="observable">Operation that can be observed</param>
/// <param name="session"><see cref="CimSession"/> object that issued the operation.</param>
/// <param name="observable">Operation that can be observed.</param>
public CimResultObserver(CimSession session, IObservable<object> observable)
{
this.session = session;
Expand All @@ -245,8 +245,8 @@ public CimResultObserver(CimSession session, IObservable<object> observable)
/// <summary>
/// Constructor
/// </summary>
/// <param name="session"><see cref="CimSession"/> object that issued the operation</param>
/// <param name="observable">Operation that can be observed</param>
/// <param name="session"><see cref="CimSession"/> object that issued the operation.</param>
/// <param name="observable">Operation that can be observed.</param>
public CimResultObserver(CimSession session,
IObservable<object> observable,
CimResultContext cimResultContext)
Expand Down Expand Up @@ -285,7 +285,7 @@ public virtual void OnCompleted()
/// Operation completed with an error
/// </para>
/// </summary>
/// <param name="error">error object</param>
/// <param name="error">error object.</param>
public virtual void OnError(Exception error)
{
try
Expand Down Expand Up @@ -326,7 +326,7 @@ protected void OnNextCore(object value)
/// Operation got a new result object
/// </para>
/// </summary>
/// <param name="value">result object</param>
/// <param name="value">result object.</param>
public virtual void OnNext(T value)
{
DebugHelper.WriteLogEx("value = {0}.", 1, value);
Expand Down
8 changes: 4 additions & 4 deletions src/Microsoft.Management.Infrastructure.CimCmdlets/CimSessionOperations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ public void Dispose()
/// other objects. Only unmanaged resources can be disposed.
/// </para>
/// </summary>
/// <param name="disposing">Whether it is directly called</param>
/// <param name="disposing">Whether it is directly called.</param>
protected virtual void Dispose(bool disposing)
{
if (!this._disposed)
Expand Down Expand Up @@ -858,8 +858,8 @@ public static CimSessionState GetCimSessionState()
/// clean up the dictionaries if the runspace is closed or broken.
/// </para>
/// </summary>
/// <param name="sender">Runspace</param>
/// <param name="e">Event args</param>
/// <param name="sender">Runspace.</param>
/// <param name="e">Event args.</param>
private static void DefaultRunspace_StateChanged(object sender, RunspaceStateEventArgs e)
{
Runspace runspace = (Runspace)sender;
Expand Down Expand Up @@ -1097,7 +1097,7 @@ public void Dispose()
/// other objects. Only unmanaged resources can be disposed.
/// </para>
/// </summary>
/// <param name="disposing">Whether it is directly called</param>
/// <param name="disposing">Whether it is directly called.</param>
protected virtual void Dispose(bool disposing)
{
if (!this._disposed)
Expand Down
Loading