Skip to content

Commit

Permalink
[6.0] Remove excessive spaces from XML doc comments (#26170)
Browse files Browse the repository at this point in the history
  • Loading branch information
ajcvickers authored Sep 24, 2021
1 parent 068641e commit 289e7a6
Show file tree
Hide file tree
Showing 998 changed files with 14,697 additions and 14,695 deletions.
1 change: 1 addition & 0 deletions All.sln.DotSettings
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/JavaScriptCodeFormatting/ALIGN_MULTIPLE_DECLARATION/@EntryValue">True</s:Boolean>

<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/JavaScriptCodeFormatting/JavaScriptFormatOther/ALIGN_MULTIPLE_DECLARATION/@EntryValue">True</s:Boolean>
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/XmlDocFormatter/KeepUserLineBreaks/@EntryValue">True</s:Boolean>
<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/XmlDocFormatter/WrapLimit/@EntryValue">140</s:Int64>
<s:Int64 x:Key="/Default/CodeStyle/CodeFormatting/XmlDocFormatter/WRAP_LIMIT/@EntryValue">140</s:Int64>
<s:Boolean x:Key="/Default/CodeStyle/CodeFormatting/XmlFormatter/WrapBeforeAttr/@EntryValue">False</s:Boolean>
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Abstractions/BackingFieldAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public sealed class BackingFieldAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="BackingFieldAttribute" /> class.
/// </summary>
/// <param name="name"> The name of the backing field. </param>
/// <param name="name">The name of the backing field.</param>
public BackingFieldAttribute(string name)
{
Check.NotEmpty(name, nameof(name));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ private void ObservableCollectionChanged(object? sender, NotifyCollectionChanged
// <summary>
// Adds the item to the underlying observable collection.
// </summary>
// <param name="item"> The item. </param>
// <param name="item">The item.</param>
private void AddToObservableCollection(T item)
{
// Don't try to change the ObservableCollection if the original change
Expand All @@ -251,7 +251,7 @@ private void AddToObservableCollection(T item)
// <summary>
// Removes the item from the underlying from observable collection.
// </summary>
// <param name="item"> The item. </param>
// <param name="item">The item.</param>
private void RemoveFromObservableCollection(T item)
{
// Don't try to change the ObservableCollection if the original change
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-local-views">Local views of tracked entities in EF Core</see> for more information.
/// </remarks>
/// <typeparam name="T"> The type of elements in the collection. </typeparam>
/// <typeparam name="T">The type of elements in the collection.</typeparam>
public class ObservableCollectionListSource<T> : ObservableCollection<T>, IListSource
where T : class
{
Expand All @@ -41,7 +41,7 @@ public ObservableCollectionListSource()
/// Initializes a new instance of the <see cref="ObservableCollectionListSource{T}" /> class that
/// contains elements copied from the specified collection.
/// </summary>
/// <param name="collection"> The collection from which the elements are copied. </param>
/// <param name="collection">The collection from which the elements are copied.</param>
public ObservableCollectionListSource(IEnumerable<T> collection)
: base(collection)
{
Expand All @@ -51,7 +51,7 @@ public ObservableCollectionListSource(IEnumerable<T> collection)
/// Initializes a new instance of the <see cref="ObservableCollectionListSource{T}" /> class that
/// contains elements copied from the specified list.
/// </summary>
/// <param name="list"> The list from which the elements are copied. </param>
/// <param name="list">The list from which the elements are copied.</param>
public ObservableCollectionListSource(List<T> list)
: base(list)
{
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Abstractions/CommentAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public sealed class CommentAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="CommentAttribute" /> class.
/// </summary>
/// <param name="comment"> The comment. </param>
/// <param name="comment">The comment.</param>
public CommentAttribute(string comment)
{
Check.NotEmpty(comment, nameof(comment));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public sealed class EntityTypeConfigurationAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="EntityTypeConfigurationAttribute" /> class.
/// </summary>
/// <param name="entityConfigurationType"> The IEntityTypeConfiguration&lt;&gt; type to use. </param>
/// <param name="entityConfigurationType">The IEntityTypeConfiguration&lt;&gt; type to use.</param>
public EntityTypeConfigurationAttribute(Type entityConfigurationType)
{
Check.NotNull(entityConfigurationType, nameof(entityConfigurationType));
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Abstractions/IndexAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public sealed class IndexAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="IndexAttribute" /> class.
/// </summary>
/// <param name="propertyNames"> The properties which constitute the index, in order (there must be at least one). </param>
/// <param name="propertyNames">The properties which constitute the index, in order (there must be at least one).</param>
public IndexAttribute(params string[] propertyNames)
{
Check.NotEmpty(propertyNames, nameof(propertyNames));
Expand Down
20 changes: 10 additions & 10 deletions src/EFCore.Abstractions/Infrastructure/ILazyLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ public interface ILazyLoader : IDisposable
/// Sets the given navigation as known to be completely loaded or known to be
/// no longer completely loaded.
/// </summary>
/// <param name="entity"> The entity on which the navigation property is located. </param>
/// <param name="navigationName"> The navigation property name. </param>
/// <param name="loaded"> Determines whether the navigation is set as loaded or not. </param>
/// <param name="entity">The entity on which the navigation property is located.</param>
/// <param name="navigationName">The navigation property name.</param>
/// <param name="loaded">Determines whether the navigation is set as loaded or not.</param>
void SetLoaded(
object entity,
[CallerMemberName] string navigationName = "",
Expand All @@ -40,18 +40,18 @@ void SetLoaded(
/// <summary>
/// Loads a navigation property if it has not already been loaded.
/// </summary>
/// <param name="entity"> The entity on which the navigation property is located. </param>
/// <param name="navigationName"> The navigation property name. </param>
/// <param name="entity">The entity on which the navigation property is located.</param>
/// <param name="navigationName">The navigation property name.</param>
void Load(object entity, [CallerMemberName] string navigationName = "");

/// <summary>
/// Loads a navigation property if it has not already been loaded.
/// </summary>
/// <param name="entity"> The entity on which the navigation property is located. </param>
/// <param name="cancellationToken"> A <see cref="CancellationToken" /> to observe while waiting for the task to complete. </param>
/// <param name="navigationName"> The navigation property name. </param>
/// <returns> A task that represents the asynchronous operation. </returns>
/// <exception cref="OperationCanceledException"> If the <see cref="CancellationToken" /> is canceled. </exception>
/// <param name="entity">The entity on which the navigation property is located.</param>
/// <param name="cancellationToken">A <see cref="CancellationToken" /> to observe while waiting for the task to complete.</param>
/// <param name="navigationName">The navigation property name.</param>
/// <returns>A task that represents the asynchronous operation.</returns>
/// <exception cref="OperationCanceledException">If the <see cref="CancellationToken" /> is canceled.</exception>
#pragma warning disable CA1068 // CancellationToken parameters must come last
Task LoadAsync(
#pragma warning restore CA1068 // CancellationToken parameters must come last
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ public static class LazyLoaderExtensions
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-lazy-loading">Lazy loading</see> for more information.
/// </remarks>
/// <typeparam name="TRelated"> The type of the navigation property. </typeparam>
/// <typeparam name="TRelated">The type of the navigation property.</typeparam>
/// <param name="loader">The loader instance, which may be <see langword="null" />.</param>
/// <param name="entity"> The entity on which the navigation property is located. </param>
/// <param name="navigationField"> A reference to the backing field for the navigation. </param>
/// <param name="navigationName"> The navigation property name. </param>
/// <param name="entity">The entity on which the navigation property is located.</param>
/// <param name="navigationField">A reference to the backing field for the navigation.</param>
/// <param name="navigationName">The navigation property name.</param>
/// <returns>
/// The loaded navigation property value, or the navigation property value unchanged if the loader is <see langword="null" />.
/// </returns>
Expand Down
6 changes: 3 additions & 3 deletions src/EFCore.Abstractions/ObservableCollectionExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ public static class ObservableCollectionExtensions
/// Returns a <see cref="BindingList{T}" /> implementation that stays in sync with the given
/// <see cref="ObservableCollection{T}" />.
/// </summary>
/// <typeparam name="T"> The element type. </typeparam>
/// <param name="source"> The collection that the binding list will stay in sync with. </param>
/// <returns> The binding list. </returns>
/// <typeparam name="T">The element type.</typeparam>
/// <param name="source">The collection that the binding list will stay in sync with.</param>
/// <returns>The binding list.</returns>
public static BindingList<T> ToBindingList<T>(this ObservableCollection<T> source)
where T : class
{
Expand Down
6 changes: 3 additions & 3 deletions src/EFCore.Abstractions/PrecisionAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ public class PrecisionAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="PrecisionAttribute" /> class.
/// </summary>
/// <param name="precision"> The precision of the property. </param>
/// <param name="scale"> The scale of the property. </param>
/// <param name="precision">The precision of the property.</param>
/// <param name="scale">The scale of the property.</param>
public PrecisionAttribute(int precision, int scale)
{
if (precision < 0)
Expand All @@ -41,7 +41,7 @@ public PrecisionAttribute(int precision, int scale)
/// <summary>
/// Initializes a new instance of the <see cref="PrecisionAttribute" /> class.
/// </summary>
/// <param name="precision"> The precision of the property. </param>
/// <param name="precision">The precision of the property.</param>
public PrecisionAttribute(int precision)
{
if (precision < 0)
Expand Down
2 changes: 1 addition & 1 deletion src/EFCore.Abstractions/UnicodeAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public sealed class UnicodeAttribute : Attribute
/// <summary>
/// Initializes a new instance of the <see cref="UnicodeAttribute" /> class.
/// </summary>
/// <param name="unicode"> A value indicating whether the property can contain unicode characters or not. </param>
/// <param name="unicode">A value indicating whether the property can contain unicode characters or not.</param>
public UnicodeAttribute(bool unicode = true)
{
IsUnicode = unicode;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ public class CosmosItemCommandExecutedEventData : EventData
/// <summary>
/// Constructs the event payload.
/// </summary>
/// <param name="eventDefinition"> The event definition. </param>
/// <param name="messageGenerator"> A delegate that generates a log message for this event. </param>
/// <param name="elapsed"> The time elapsed since the command was sent to the database. </param>
/// <param name="requestCharge"> The request charge in RU. </param>
/// <param name="activityId"> The activity ID. </param>
/// <param name="resourceId"> The ID of the resource being read. </param>
/// <param name="containerId"> The ID of the Cosmos container being queried. </param>
/// <param name="partitionKey"> The key of the Cosmos partition that the query is using. </param>
/// <param name="logSensitiveData"> Indicates whether the application allows logging of sensitive data. </param>
/// <param name="eventDefinition">The event definition.</param>
/// <param name="messageGenerator">A delegate that generates a log message for this event.</param>
/// <param name="elapsed">The time elapsed since the command was sent to the database.</param>
/// <param name="requestCharge">The request charge in RU.</param>
/// <param name="activityId">The activity ID.</param>
/// <param name="resourceId">The ID of the resource being read.</param>
/// <param name="containerId">The ID of the Cosmos container being queried.</param>
/// <param name="partitionKey">The key of the Cosmos partition that the query is using.</param>
/// <param name="logSensitiveData">Indicates whether the application allows logging of sensitive data.</param>
public CosmosItemCommandExecutedEventData(
EventDefinitionBase eventDefinition,
Func<EventDefinitionBase, EventData, string> messageGenerator,
Expand Down
14 changes: 7 additions & 7 deletions src/EFCore.Cosmos/Diagnostics/CosmosQueryEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ public class CosmosQueryEventData : EventData
/// <summary>
/// Constructs the event payload.
/// </summary>
/// <param name="eventDefinition"> The event definition. </param>
/// <param name="messageGenerator"> A delegate that generates a log message for this event. </param>
/// <param name="containerId"> The ID of the Cosmos container being queried. </param>
/// <param name="partitionKey"> The key of the Cosmos partition that the query is using. </param>
/// <param name="parameters"> Name/values for each parameter in the Cosmos Query. </param>
/// <param name="querySql"> The SQL representing the query. </param>
/// <param name="logSensitiveData"> Indicates whether the application allows logging of sensitive data. </param>
/// <param name="eventDefinition">The event definition.</param>
/// <param name="messageGenerator">A delegate that generates a log message for this event.</param>
/// <param name="containerId">The ID of the Cosmos container being queried.</param>
/// <param name="partitionKey">The key of the Cosmos partition that the query is using.</param>
/// <param name="parameters">Name/values for each parameter in the Cosmos Query.</param>
/// <param name="querySql">The SQL representing the query.</param>
/// <param name="logSensitiveData">Indicates whether the application allows logging of sensitive data.</param>
public CosmosQueryEventData(
EventDefinitionBase eventDefinition,
Func<EventDefinitionBase, EventData, string> messageGenerator,
Expand Down
20 changes: 10 additions & 10 deletions src/EFCore.Cosmos/Diagnostics/CosmosQueryExecutedEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ public class CosmosQueryExecutedEventData : EventData
/// <summary>
/// Constructs the event payload.
/// </summary>
/// <param name="eventDefinition"> The event definition. </param>
/// <param name="messageGenerator"> A delegate that generates a log message for this event. </param>
/// <param name="elapsed"> The time elapsed since the command was sent to the database. </param>
/// <param name="requestCharge"> The request charge in RU. </param>
/// <param name="activityId"> The activity ID. </param>
/// <param name="containerId"> The ID of the Cosmos container being queried. </param>
/// <param name="partitionKey"> The key of the Cosmos partition that the query is using. </param>
/// <param name="parameters"> Name/values for each parameter in the Cosmos Query. </param>
/// <param name="querySql"> The SQL representing the query. </param>
/// <param name="logSensitiveData"> Indicates whether the application allows logging of sensitive data. </param>
/// <param name="eventDefinition">The event definition.</param>
/// <param name="messageGenerator">A delegate that generates a log message for this event.</param>
/// <param name="elapsed">The time elapsed since the command was sent to the database.</param>
/// <param name="requestCharge">The request charge in RU.</param>
/// <param name="activityId">The activity ID.</param>
/// <param name="containerId">The ID of the Cosmos container being queried.</param>
/// <param name="partitionKey">The key of the Cosmos partition that the query is using.</param>
/// <param name="parameters">Name/values for each parameter in the Cosmos Query.</param>
/// <param name="querySql">The SQL representing the query.</param>
/// <param name="logSensitiveData">Indicates whether the application allows logging of sensitive data.</param>
public CosmosQueryExecutedEventData(
EventDefinitionBase eventDefinition,
Func<EventDefinitionBase, EventData, string> messageGenerator,
Expand Down
12 changes: 6 additions & 6 deletions src/EFCore.Cosmos/Diagnostics/CosmosReadItemEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ public class CosmosReadItemEventData : EventData
/// <summary>
/// Constructs the event payload.
/// </summary>
/// <param name="eventDefinition"> The event definition. </param>
/// <param name="messageGenerator"> A delegate that generates a log message for this event. </param>
/// <param name="resourceId"> The ID of the resource being read. </param>
/// <param name="containerId"> The ID of the Cosmos container being queried. </param>
/// <param name="partitionKey"> The key of the Cosmos partition that the query is using. </param>
/// <param name="logSensitiveData"> Indicates whether the application allows logging of sensitive data. </param>
/// <param name="eventDefinition">The event definition.</param>
/// <param name="messageGenerator">A delegate that generates a log message for this event.</param>
/// <param name="resourceId">The ID of the resource being read.</param>
/// <param name="containerId">The ID of the Cosmos container being queried.</param>
/// <param name="partitionKey">The key of the Cosmos partition that the query is using.</param>
/// <param name="logSensitiveData">Indicates whether the application allows logging of sensitive data.</param>
public CosmosReadItemEventData(
EventDefinitionBase eventDefinition,
Func<EventDefinitionBase, EventData, string> messageGenerator,
Expand Down
Loading

0 comments on commit 289e7a6

Please sign in to comment.