Skip to content
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.

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

Approach for referencing conceptual docs #25530

Merged
merged 3 commits into from
Aug 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ArrayStructuralComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// A new array is constructed when snapshotting.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
/// <typeparam name="TElement"> The array element type. </typeparam>
public class ArrayStructuralComparer<TElement> : ValueComparer<TElement[]>
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/CascadeTiming.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// Defines different strategies for when cascading actions will be performed.
/// See <see cref="ChangeTracker.CascadeDeleteTiming" /> and <see cref="ChangeTracker.DeleteOrphansTiming" />.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-cascading">EF Core cascade deletes and deleting orphans</see>.
/// </remarks>
public enum CascadeTiming
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ChangeTracker.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// Instances of this class are typically obtained from <see cref="DbContext.ChangeTracker" /> and it is not designed
/// to be directly constructed in your application code.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-change-tracking">EF Core change tracking</see>.
/// </remarks>
public class ChangeTracker : IResettableService
{
private readonly IRuntimeModel _model;
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore/ChangeTracking/ChangeTrackerDebugStringOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <summary>
/// Debug string customization options for tracked entities.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-change-tracking">EF Core change tracking</see> and
/// <see href="https://aka.ms/efcore-docs-debug-views">EF Core debug views</see>.
/// </remarks>
[Flags]
public enum ChangeTrackerDebugStringOptions
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ChangeTrackerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Extension methods for <see cref="ChangeTracker" />.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-change-tracking">EF Core change tracking</see>.
/// </remarks>
public static class ChangeTrackerExtensions
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/CollectionEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public class CollectionEntry : NavigationEntry
{
private ICollectionLoader? _loader;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/CollectionEntry`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="TEntity"> The type of the entity the property belongs to. </typeparam>
/// <typeparam name="TRelatedEntity"> The type of the property. </typeparam>
public class CollectionEntry<TEntity, TRelatedEntity> : CollectionEntry
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
[DebuggerDisplay("{" + nameof(InternalEntry) + ",nq}")]
public class EntityEntry : IInfrastructure<InternalEntityEntry>
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityEntryEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <summary>
/// Event arguments for events relating to tracked <see cref="EntityEntry" />s.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public class EntityEntryEventArgs : EventArgs
{
private readonly InternalEntityEntry _internalEntityEntry;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityEntryGraphNode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// See <see cref="M:ChangeTracker.TrackGraph" /> for information on how graph nodes are used.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-track-graph">Tracking entities in EF Core</see>.
/// </remarks>
public class EntityEntryGraphNode : IInfrastructure<InternalEntityEntry>
{
private readonly InternalEntityEntry _entry;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityEntryGraphNode`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// Provides access to change tracking information and operations for a node in a
/// graph of entities that is being traversed.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-track-graph">Tracking entities in EF Core</see>.
/// </remarks>
public class EntityEntryGraphNode<TState> : EntityEntryGraphNode
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityEntry`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="TEntity"> The type of entity being tracked by this entry. </typeparam>
public class EntityEntry<TEntity> : EntityEntry
where TEntity : class
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityStateChangedEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <summary>
/// Event arguments for the <see cref="ChangeTracker.StateChanged" /> event.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-state-changes">State changes of entities in EF Core</see>.
/// </remarks>
public class EntityStateChangedEventArgs : EntityEntryEventArgs
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntityTrackedEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <summary>
/// Event arguments for the <see cref="ChangeTracker.Tracked" /> event.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-state-changes">State changes of entities in EF Core</see>.
/// </remarks>
public class EntityTrackedEventArgs : EntityEntryEventArgs
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/EntryCurrentValueComparer`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
/// <typeparam name="TProperty"> The type of the property. </typeparam>
public sealed class EntryCurrentValueComparer<TProperty> : IComparer<IUpdateEntry>, IEqualityComparer<IUpdateEntry>
{
Expand Down
4 changes: 3 additions & 1 deletion src/EFCore/ChangeTracking/GeometryValueComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@

using System;
using System.Linq.Expressions;
using System.Reflection;

namespace Microsoft.EntityFrameworkCore.ChangeTracking
{
/// <summary>
/// Value snapshotting and comparison logic for NetTopologySuite.Geometries.Geometry instances.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
public class GeometryValueComparer<TGeometry> : ValueComparer<TGeometry>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/IDependentKeyValueFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-providers">EF Core database providers</see>.
/// </remarks>
/// <typeparam name="TKey"> The generic type of the key. </typeparam>
public interface IDependentKeyValueFactory<TKey>
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/IEntityEntryGraphIterator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// This service cannot depend on services registered as <see cref="ServiceLifetime.Scoped" />.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-track-graph">Tracking entities in EF Core</see>.
/// </remarks>
public interface IEntityEntryGraphIterator
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/IPrincipalKeyValueFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-providers">EF Core database providers</see>.
/// </remarks>
/// <typeparam name="TKey"> The key type. </typeparam>
public interface IPrincipalKeyValueFactory<TKey>
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/LocalView.cs
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// for WPF binding, or <see cref="ToBindingList" /> for WinForms.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-local-views">Local views of tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="TEntity">The type of the entity in the local view.</typeparam>
public class LocalView<TEntity> :
ICollection<TEntity>,
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/MemberEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public abstract class MemberEntry : IInfrastructure<InternalEntityEntry>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/NavigationEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public abstract class NavigationEntry : MemberEntry
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ObservableHashSet.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// A hash set that implements the interfaces required for Entity Framework to use notification based change tracking
/// for a collection navigation property.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-local-views">Local views of tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="T"> The type of elements in the hash set. </typeparam>
public class ObservableHashSet<T>
: ISet<T>, IReadOnlyCollection<T>, INotifyCollectionChanged, INotifyPropertyChanged, INotifyPropertyChanging
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/PropertyEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public class PropertyEntry : MemberEntry
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/PropertyEntry`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="TEntity"> The type of the entity the property belongs to. </typeparam>
/// <typeparam name="TProperty"> The type of the property. </typeparam>
public class PropertyEntry<TEntity, TProperty> : PropertyEntry
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/PropertyValues.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// concurrency exceptions signaled by the throwing of a <see cref="DbUpdateConcurrencyException" />.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public abstract class PropertyValues
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ReferenceEntry.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
public class ReferenceEntry : NavigationEntry
{
private IEntityFinder? _finder;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ReferenceEntry`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <typeparam name="TEntity"> The type of the entity the property belongs to. </typeparam>
/// <typeparam name="TProperty"> The type of the property. </typeparam>
public class ReferenceEntry<TEntity, TProperty> : ReferenceEntry
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ValueComparer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// reference.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
public abstract class ValueComparer : IEqualityComparer, IEqualityComparer<object>
{
private static readonly MethodInfo _doubleEqualsMethodInfo
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ValueComparerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// <summary>
/// Extension methods for <see cref="ValueComparer" />.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
public static class ValueComparerExtensions
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ValueComparer`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// reference.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-value-comparers">EF Core value comparers</see>.
/// </remarks>
/// <typeparam name="T"> The type. </typeparam>
public class ValueComparer<T> : ValueComparer, IEqualityComparer<T>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// The .NET Foundation licenses this file to you under the MIT license.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore.TestModels.Northwind;
Expand Down