Skip to content

Commit d9f39f3

Browse files
Fix Common proj XML comments (#327)
Co-authored-by: Yabo Hu <[email protected]>
1 parent 06b626b commit d9f39f3

File tree

5 files changed

+4
-6
lines changed

5 files changed

+4
-6
lines changed

src/Common/AzureLongRunningJob.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -547,7 +547,6 @@ bool CanHandleShouldProcessLocally()
547547
/// <summary>
548548
/// Throw if the job was terminated by failure or cancellation
549549
/// </summary>
550-
/// <param name="runtimeAction"></param>
551550
protected void ThrowIfJobFailedOrCancelled()
552551
{
553552
lock (_lockObject)
@@ -803,6 +802,7 @@ internal bool IsFailedOrCancelled(JobState state)
803802
/// Queue actions that must occur on the cmdlet thread, and block the current thread until they are completed
804803
/// </summary>
805804
/// <param name="shouldMethod">The action to invoke</param>
805+
/// <param name="methodType"></param>
806806
/// <param name="exceptionThrownOnCmdletThread">Any exception that results</param>
807807
/// <returns>The result of executing the action on the cmdlet thread</returns>
808808
private bool InvokeShouldMethodAndWaitForResults(Func<Cmdlet, bool> shouldMethod, ShouldMethodType methodType, out Exception exceptionThrownOnCmdletThread)

src/Common/CustomAttributes/CmdletParameterBreakingChangeAttribute.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ protected override string GetAttributeSpecificMessage()
9393
/// then the attribbute is applicable
9494
/// If the invocationInfo is null we return true
9595
/// </summary>
96-
/// <param name="invocation"></param>
96+
/// <param name="invocationInfo"></param>
9797
/// <returns>bool</returns>
9898
public override bool IsApplicableToInvocation(InvocationInfo invocationInfo)
9999
{

src/Common/CustomAttributes/GenericBreakingChangeAttribute.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ namespace Microsoft.WindowsAzure.Commands.Common.CustomAttributes
2929
AttributeTargets.Property,
3030
AllowMultiple = true)]
3131

32-
/**
32+
/*
3333
* This class acts as the base
34-
**/
34+
*/
3535
public class GenericBreakingChangeAttribute : System.Attribute
3636
{
3737
private string _message;

src/Common/Exceptions/AzPSIOException.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,6 @@ public AzPSIOException(
137137
/// <param name="message">The error message that explains the reason for the exception.</param>
138138
/// <param name="errorKind">ErrorKind that causes this exception.</param>
139139
/// <param name="hresult">An integer identifying the error that has occurred.</param>
140-
/// <param name="innerException">The exception that is the cause of the current exception. Default value is null.</param>
141140
/// <param name="desensitizedMessage">The error message which doesn't contain PII.</param>
142141
/// <param name="lineNumber">The number of line when exception happens.</param>
143142
/// <param name="filePath">The file path when exception happens.</param>

src/Common/Extensions/CmdletExtensions.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,6 @@ public static void SafeCopyParameterSet<T>(this T source, T target) where T : Az
207207
/// <summary>
208208
/// Return the value of a paramater, or null if not set
209209
/// </summary>
210-
/// <typeparam name="T"></typeparam>
211210
/// <param name="cmdlet">the executing cmdlet</param>
212211
/// <param name="parameterName">The name of the parameter to return</param>
213212
/// <returns>true if the parameter was provided by the user, otherwise false</returns>

0 commit comments

Comments
 (0)