Skip to content

Use consistent spacing in xml documentation tags #14231

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 7 commits into from
Nov 25, 2020
Merged

Use consistent spacing in xml documentation tags #14231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4de5967
paramref
xtqqczze Nov 23, 2020
a1d85f7
see paramref
xtqqczze Nov 23, 2020
b139028
see langword
xtqqczze Nov 23, 2020
508a3cf
see cref
xtqqczze Nov 23, 2020
c1deec3
inheritdoc
xtqqczze Nov 23, 2020
f21d2d3
exception cref
xtqqczze Nov 23, 2020
9697974
Merge branch 'master' into DOC-tags
xtqqczze Nov 24, 2020
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
4 changes: 2 additions & 2 deletions src/Microsoft.PowerShell.Commands.Diagnostics/CoreCLR/Stubs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ public enum PerformanceCounterCategoryType
}

/// <summary>
/// Specifies the formula used to calculate the <see cref="M:System.Diagnostics.PerformanceCounter.NextValue" />
/// method for a <see cref="T:System.Diagnostics.PerformanceCounter" /> instance.
/// Specifies the formula used to calculate the <see cref="M:System.Diagnostics.PerformanceCounter.NextValue"/>
/// method for a <see cref="T:System.Diagnostics.PerformanceCounter"/> instance.
/// </summary>
/// <filterpriority>2</filterpriority>
public enum PerformanceCounterType
Expand Down
12 changes: 6 additions & 6 deletions src/Microsoft.PowerShell.Commands.Management/cimSupport/cmdletization/SessionBasedWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ public SwitchParameter AsJob
/// Doing so will interfere with ThrottleLimit functionality.
/// </para>
/// <para>
/// <see cref="Job.WriteObject" /> (and other methods returning job results) will block to support throttling and flow-control.
/// <see cref="Job.WriteObject"/> (and other methods returning job results) will block to support throttling and flow-control.
/// Implementations of Job instance returned from this method should make sure that implementation-specific flow-control mechanism pauses further processing,
/// until calls from <see cref="Job.WriteObject" /> (and other methods returning job results) return.
/// until calls from <see cref="Job.WriteObject"/> (and other methods returning job results) return.
/// </para>
/// </remarks>
internal abstract StartableJob CreateQueryJob(TSession session, QueryBuilder query);
Expand Down Expand Up @@ -178,9 +178,9 @@ private StartableJob DoCreateQueryJob(TSession sessionForJob, QueryBuilder query
/// Doing so will interfere with ThrottleLimit functionality.
/// </para>
/// <para>
/// <see cref="Job.WriteObject" /> (and other methods returning job results) will block to support throttling and flow-control.
/// <see cref="Job.WriteObject"/> (and other methods returning job results) will block to support throttling and flow-control.
/// Implementations of Job instance returned from this method should make sure that implementation-specific flow-control mechanism pauses further processing,
/// until calls from <see cref="Job.WriteObject" /> (and other methods returning job results) return.
/// until calls from <see cref="Job.WriteObject"/> (and other methods returning job results) return.
/// </para>
/// </remarks>
internal abstract StartableJob CreateInstanceMethodInvocationJob(TSession session, TObjectInstance objectInstance, MethodInvocationInfo methodInvocationInfo, bool passThru);
Expand Down Expand Up @@ -213,9 +213,9 @@ private StartableJob DoCreateInstanceMethodInvocationJob(TSession sessionForJob,
/// Doing so will interfere with ThrottleLimit functionality.
/// </para>
/// <para>
/// <see cref="Job.WriteObject" /> (and other methods returning job results) will block to support throttling and flow-control.
/// <see cref="Job.WriteObject"/> (and other methods returning job results) will block to support throttling and flow-control.
/// Implementations of Job instance returned from this method should make sure that implementation-specific flow-control mechanism pauses further processing,
/// until calls from <see cref="Job.WriteObject" /> (and other methods returning job results) return.
/// until calls from <see cref="Job.WriteObject"/> (and other methods returning job results) return.
/// </para>
/// </remarks>
internal abstract StartableJob CreateStaticMethodInvocationJob(TSession session, MethodInvocationInfo methodInvocationInfo);
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/Join-String.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public string Separator
[Parameter(ValueFromPipeline = true)]
public PSObject[] InputObject { get; set; }

/// <inheritdoc />
/// <inheritdoc/>
protected override void BeginProcessing()
{
_quoteChar = SingleQuote ? '\'' : DoubleQuote ? '"' : char.MinValue;
Expand All @@ -104,7 +104,7 @@ protected override void BeginProcessing()
}
}

/// <inheritdoc />
/// <inheritdoc/>
protected override void ProcessRecord()
{
if (InputObject != null)
Expand Down Expand Up @@ -151,7 +151,7 @@ protected override void ProcessRecord()
}
}

/// <inheritdoc />
/// <inheritdoc/>
protected override void EndProcessing()
{
_outputBuilder.Append(OutputSuffix);
Expand Down
6 changes: 3 additions & 3 deletions src/Microsoft.PowerShell.Commands.Utility/commands/utility/MatchString.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ private class CircularBuffer<T> : ICollection<T>
/// Initializes a new instance of the <see cref="CircularBuffer{T}"/> class.
/// </summary>
/// <param name="capacity">The maximum capacity of the buffer.</param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="capacity" /> is negative.</exception>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="capacity"/> is negative.</exception>
public CircularBuffer(int capacity)
{
if (capacity < 0)
Expand Down Expand Up @@ -455,9 +455,9 @@ public CircularBuffer(int capacity)
/// has been properly offset and wrapped.
/// </summary>
/// <param name="zeroBasedIndex">The index to wrap.</param>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="zeroBasedIndex" /> is out of range.</exception>
/// <exception cref="ArgumentOutOfRangeException">If <paramref name="zeroBasedIndex"/> is out of range.</exception>
/// <returns>
/// The actual index that <paramref name="zeroBasedIndex" />
/// The actual index that <paramref name="zeroBasedIndex"/>
/// maps to.
/// </returns>
private int WrapIndex(int zeroBasedIndex)
Expand Down
24 changes: 12 additions & 12 deletions ...owerShell.Commands.Utility/commands/utility/WebCmdlet/Common/WebRequestPSCmdlet.Common.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1856,12 +1856,12 @@ internal void ParseLinkHeader(HttpResponseMessage response, System.Uri requestUr
}

/// <summary>
/// Adds content to a <see cref="MultipartFormDataContent" />. Object type detection is used to determine if the value is string, File, or Collection.
/// Adds content to a <see cref="MultipartFormDataContent"/>. Object type detection is used to determine if the value is string, File, or Collection.
/// </summary>
/// <param name="fieldName">The Field Name to use.</param>
/// <param name="fieldValue">The Field Value to use.</param>
/// <param name="formData">The <see cref="MultipartFormDataContent" />> to update.</param>
/// <param name="enumerate">If true, collection types in <paramref name="fieldValue" /> will be enumerated. If false, collections will be treated as single value.</param>
/// <param name="formData">The <see cref="MultipartFormDataContent"/>> to update.</param>
/// <param name="enumerate">If true, collection types in <paramref name="fieldValue"/> will be enumerated. If false, collections will be treated as single value.</param>
private void AddMultipartContent(object fieldName, object fieldValue, MultipartFormDataContent formData, bool enumerate)
{
if (formData == null)
Expand Down Expand Up @@ -1912,10 +1912,10 @@ private void AddMultipartContent(object fieldName, object fieldValue, MultipartF
}

/// <summary>
/// Gets a <see cref="StringContent" /> from the supplied field name and field value. Uses <see cref="LanguagePrimitives.ConvertTo{T}(object)" /> to convert the objects to strings.
/// Gets a <see cref="StringContent"/> from the supplied field name and field value. Uses <see cref="LanguagePrimitives.ConvertTo{T}(object)"/> to convert the objects to strings.
/// </summary>
/// <param name="fieldName">The Field Name to use for the <see cref="StringContent" /></param>
/// <param name="fieldValue">The Field Value to use for the <see cref="StringContent" /></param>
/// <param name="fieldName">The Field Name to use for the <see cref="StringContent"/></param>
/// <param name="fieldValue">The Field Value to use for the <see cref="StringContent"/></param>
private static StringContent GetMultipartStringContent(object fieldName, object fieldValue)
{
var contentDisposition = new ContentDispositionHeaderValue("form-data");
Expand All @@ -1929,10 +1929,10 @@ private static StringContent GetMultipartStringContent(object fieldName, object
}

/// <summary>
/// Gets a <see cref="StreamContent" /> from the supplied field name and <see cref="Stream" />. Uses <see cref="LanguagePrimitives.ConvertTo{T}(object)" /> to convert the fieldname to a string.
/// Gets a <see cref="StreamContent"/> from the supplied field name and <see cref="Stream"/>. Uses <see cref="LanguagePrimitives.ConvertTo{T}(object)"/> to convert the fieldname to a string.
/// </summary>
/// <param name="fieldName">The Field Name to use for the <see cref="StreamContent" /></param>
/// <param name="stream">The <see cref="Stream" /> to use for the <see cref="StreamContent" /></param>
/// <param name="fieldName">The Field Name to use for the <see cref="StreamContent"/></param>
/// <param name="stream">The <see cref="Stream"/> to use for the <see cref="StreamContent"/></param>
private static StreamContent GetMultipartStreamContent(object fieldName, Stream stream)
{
var contentDisposition = new ContentDispositionHeaderValue("form-data");
Expand All @@ -1947,10 +1947,10 @@ private static StreamContent GetMultipartStreamContent(object fieldName, Stream
}

/// <summary>
/// Gets a <see cref="StreamContent" /> from the supplied field name and file. Calls <see cref="GetMultipartStreamContent(object, Stream)" /> to create the <see cref="StreamContent" /> and then sets the file name.
/// Gets a <see cref="StreamContent"/> from the supplied field name and file. Calls <see cref="GetMultipartStreamContent(object, Stream)"/> to create the <see cref="StreamContent"/> and then sets the file name.
/// </summary>
/// <param name="fieldName">The Field Name to use for the <see cref="StreamContent" /></param>
/// <param name="file">The file to use for the <see cref="StreamContent" /></param>
/// <param name="fieldName">The Field Name to use for the <see cref="StreamContent"/></param>
/// <param name="file">The file to use for the <see cref="StreamContent"/></param>
private static StreamContent GetMultipartFileContent(object fieldName, FileInfo file)
{
var result = GetMultipartStreamContent(fieldName: fieldName, stream: new FileStream(file.FullName, FileMode.Open));
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.PowerShell.Security/security/CertificateProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3010,7 +3010,7 @@ public string LocationName

/// <summary>
/// Gets the location as a
/// <see cref="System.Security.Cryptography.X509Certificates.StoreLocation" />
/// <see cref="System.Security.Cryptography.X509Certificates.StoreLocation"/>
/// </summary>
public StoreLocation Location
{
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/FormatAndOutput/common/DisplayDatabase/typeDataManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ internal TypeInfoDataBaseManager()
/// <param name="host">
/// Host passed to <paramref name="authorizationManager"/>. Can be null if no interactive questions should be asked.
/// </param>
/// <exception cref="ArgumentNullException" />
/// <exception cref="ArgumentNullException"/>
/// <exception cref="ArgumentException">
/// 1. FormatFile is not rooted.
/// </exception>
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/cimSupport/other/ciminstancetypeadapter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public override PSAdaptedProperty GetProperty(object baseObject, string property
return null;
}

/// <inheritdoc />
/// <inheritdoc/>
public override PSAdaptedProperty GetFirstPropertyOrDefault(object baseObject, MemberNamePredicate predicate)
{
if (predicate == null)
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/engine/SessionStateContainer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4038,7 +4038,7 @@ private bool HasChildItems(
#region CopyItem

/// <summary>
/// Copies an item at the specified path to an item at the <paramref name="copyPath" />.
/// Copies an item at the specified path to an item at the <paramref name="copyPath"/>.
/// </summary>
/// <param name="paths">
/// The path(s) of the item(s) to copy.
Expand Down Expand Up @@ -4106,7 +4106,7 @@ internal Collection<PSObject> CopyItem(string[] paths,
}

/// <summary>
/// Copies an item at the specified path to an item at the <paramref name="copyPath" />.
/// Copies an item at the specified path to an item at the <paramref name="copyPath"/>.
/// </summary>
/// <param name="paths">
/// The path(s) of the item(s) to copy.
Expand Down
6 changes: 3 additions & 3 deletions src/System.Management.Automation/engine/SessionStateScope.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ internal SessionStateScope ScriptScope
/// the provider has already been notified.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// If <paramref name="newDrive" /> is null.
/// If <paramref name="newDrive"/> is null.
/// </exception>
/// <exception cref="SessionStateException">
/// If a drive of the same name already exists in this scope.
Expand Down Expand Up @@ -165,7 +165,7 @@ internal void NewDrive(PSDriveInfo newDrive)
/// by the provider.
/// </remarks>
/// <exception cref="ArgumentNullException">
/// If <paramref name="drive" /> is null.
/// If <paramref name="drive"/> is null.
/// </exception>
internal void RemoveDrive(PSDriveInfo drive)
{
Expand Down Expand Up @@ -216,7 +216,7 @@ internal void RemoveAllDrives()
/// exists in this scope or null if one does not exist.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="name" /> is null.
/// If <paramref name="name"/> is null.
/// </exception>
internal PSDriveInfo GetDrive(string name)
{
Expand Down
8 changes: 4 additions & 4 deletions src/System.Management.Automation/engine/SessionStateVariableAPIs.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ internal object GetVariableValue(string name, object defaultValue)
/// The variable if it was found or null if it was not.
/// </returns>
/// <remarks>
/// The <paramref name="variablePath" /> is first parsed to see if it contains a drive
/// The <paramref name="variablePath"/> is first parsed to see if it contains a drive
/// specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL")
/// then only that scope is searched for the variable. If any other drive specifier
/// is found the lookup goes in the following order.
Expand Down Expand Up @@ -252,7 +252,7 @@ internal object GetVariableValue(
/// The variable if it was found or null if it was not.
/// </returns>
/// <remarks>
/// The <paramref name="variablePath" /> is first parsed to see if it contains a drive
/// The <paramref name="variablePath"/> is first parsed to see if it contains a drive
/// specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL")
/// then only that scope is searched for the variable. If any other drive specifier
/// is found the lookup goes in the following order.
Expand Down Expand Up @@ -523,7 +523,7 @@ internal object GetVariableValueFromProvider(
/// The variable if it was found or null if it was not.
/// </returns>
/// <remarks>
/// The <paramref name="variablePath" /> is first parsed to see if it contains a drive
/// The <paramref name="variablePath"/> is first parsed to see if it contains a drive
/// specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL")
/// then only that scope is searched for the variable.
/// - current scope
Expand Down Expand Up @@ -575,7 +575,7 @@ internal PSVariable GetVariableItem(
/// The variable if it was found or null if it was not.
/// </returns>
/// <remarks>
/// The <paramref name="variablePath" /> is first parsed to see if it contains a drive
/// The <paramref name="variablePath"/> is first parsed to see if it contains a drive
/// specifier or special scope. If a special scope is found ("LOCAL" or "GLOBAL")
/// then only that scope is searched for the variable.
/// - current scope
Expand Down
20 changes: 10 additions & 10 deletions src/System.Management.Automation/engine/parser/TypeInferenceVisitor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public TypeInferenceContext() : this(PowerShell.Create(RunspaceMode.CurrentRunsp
}

/// <summary>
/// Initializes a new instance of the <see cref="TypeInferenceContext" /> class.
/// Initializes a new instance of the <see cref="TypeInferenceContext"/> class.
/// The powerShell instance passed need to have a non null Runspace.
/// </summary>
/// <param name="powerShell">The instance of powershell to use for expression evaluation needed for type inference.</param>
Expand Down Expand Up @@ -2141,17 +2141,17 @@ private Type GetMostSpecificEnumeratedItemType(Type enumerableType)
/// <param name="interfaceType">The interface to test.</param>
/// <param name="hasSeenNonGeneric">
/// A reference to a value indicating whether a non-generic enumerable type has been
/// seen. If <see paramref="interfaceType" /> is a non-generic enumerable type this
/// value will be set to <see langword="true" />.
/// seen. If <see paramref="interfaceType"/> is a non-generic enumerable type this
/// value will be set to <see langword="true"/>.
/// </param>
/// <param name="hasSeenDictionaryEnumerator">
/// A reference to a value indicating whether <see cref="IDictionaryEnumerator" /> has been
/// seen. If <paramref name="interfaceType" /> is a <see cref="IDictionaryEnumerator" /> this
/// value will be set to <see langword="true" />.
/// A reference to a value indicating whether <see cref="IDictionaryEnumerator"/> has been
/// seen. If <paramref name="interfaceType"/> is a <see cref="IDictionaryEnumerator"/> this
/// value will be set to <see langword="true"/>.
/// </param>
/// <returns>
/// The value of <paramref name="interfaceType" /> if it can be used to infer a specific
/// enumerated type, otherwise <see langword="null" />.
/// The value of <paramref name="interfaceType"/> if it can be used to infer a specific
/// enumerated type, otherwise <see langword="null"/>.
/// </returns>
private Type GetGenericCollectionLikeInterface(
Type interfaceType,
Expand Down Expand Up @@ -2250,8 +2250,8 @@ private IEnumerable<PSTypeName> InferTypeFrom(IndexExpressionAst indexExpression
}

/// <summary>
/// Infers the types as if they were enumerated. For example, a <see cref="List{T}" />
/// of type <see cref="string" /> would be returned as <see cref="string" />.
/// Infers the types as if they were enumerated. For example, a <see cref="List{T}"/>
/// of type <see cref="string"/> would be returned as <see cref="string"/>.
/// </summary>
/// <param name="enumerableTypes">
/// The potentially enumerable types to infer enumerated type from.
Expand Down
2 changes: 1 addition & 1 deletion src/System.Management.Automation/engine/regex.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ public static bool ContainsWildcardCharacters(string pattern)
/// converted to their unescaped form.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="pattern" /> is null.
/// If <paramref name="pattern"/> is null.
/// </exception>
public static string Unescape(string pattern)
{
Expand Down
Loading