Skip to content

Commit

Permalink
More links to conceptual docs (#25658)
Browse files Browse the repository at this point in the history 
Part of #17508
  • Loading branch information
@ajcvickers
ajcvickers committed Aug 24, 2021
1 parent c4302d4 commit 73ad471
Show file tree
Hide file tree
Showing 92 changed files with 522 additions and 7 deletions.
27 changes: 26 additions & 1 deletion src/EFCore/ChangeTracking/CollectionEntry.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>,
/// <see href="https://aka.ms/efcore-docs-changing-relationships">Changing foreign keys and navigations</see>,
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
public class CollectionEntry : NavigationEntry
{
Expand Down Expand Up @@ -83,6 +85,10 @@ private void LocalDetectChanges()
/// the change tracker is aware of the change and <see cref="ChangeTracker.DetectChanges" /> is not required
/// for the context to detect the change.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-changing-relationships">Changing foreign keys and navigations</see>.
/// </remarks>
public new virtual IEnumerable? CurrentValue
{
get => (IEnumerable?)base.CurrentValue;
Expand All @@ -94,6 +100,10 @@ private void LocalDetectChanges()
/// with this navigation property have been modified and should be updated in the database
/// when <see cref="DbContext.SaveChanges()" /> is called.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-changing-relationships">Changing foreign keys and navigations</see>.
/// </remarks>
public override bool IsModified
{
get
Expand Down Expand Up @@ -203,6 +213,10 @@ public override bool IsModified
/// Note that entities that are already being tracked are not overwritten with new data from the database.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
public override void Load()
{
EnsureInitialized();
Expand All @@ -226,6 +240,10 @@ public override void Load()
/// that any asynchronous operations have completed before calling another method on this context.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
/// <param name="cancellationToken"> A <see cref="CancellationToken" /> to observe while waiting for the task to complete. </param>
/// <returns> A task that represents the asynchronous save operation. </returns>
/// <exception cref="OperationCanceledException"> If the <see cref="CancellationToken"/> is canceled. </exception>
Expand All @@ -248,6 +266,10 @@ public override Task LoadAsync(CancellationToken cancellationToken = default)
/// actually loading all entities from the database.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
public override IQueryable Query()
{
EnsureInitialized();
Expand All @@ -261,6 +283,9 @@ private void EnsureInitialized()
/// <summary>
/// The <see cref="EntityEntry" /> of an entity this navigation targets.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <param name="entity"> The entity to get the entry for. </param>
/// <value> An entry for an entity that this navigation targets. </value>
public virtual EntityEntry? FindEntry(object entity)
Expand Down
18 changes: 17 additions & 1 deletion src/EFCore/ChangeTracking/CollectionEntry`.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>,
/// <see href="https://aka.ms/efcore-docs-changing-relationships">Changing foreign keys and navigations</see>,
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
/// <typeparam name="TEntity"> The type of the entity the property belongs to. </typeparam>
/// <typeparam name="TRelatedEntity"> The type of the property. </typeparam>
Expand Down Expand Up @@ -55,6 +57,9 @@ public CollectionEntry(InternalEntityEntry internalEntry, INavigation navigation
/// <summary>
/// The <see cref="EntityEntry{TEntity}" /> to which this member belongs.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <value> An entry for the entity that owns this member. </value>
public new virtual EntityEntry<TEntity> EntityEntry
=> new(InternalEntry);
Expand All @@ -64,6 +69,10 @@ public CollectionEntry(InternalEntityEntry internalEntry, INavigation navigation
/// the change tracker is aware of the change and <see cref="ChangeTracker.DetectChanges" /> is not required
/// for the context to detect the change.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-changing-relationships">Changing foreign keys and navigations</see>.
/// </remarks>
public new virtual IEnumerable<TRelatedEntity>? CurrentValue
{
get => this.GetInfrastructure().GetCurrentValue<IEnumerable<TRelatedEntity>>(Metadata);
Expand All @@ -80,6 +89,10 @@ public CollectionEntry(InternalEntityEntry internalEntry, INavigation navigation
/// actually loading all entities from the database.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>
/// and <see href="https://aka.ms/efcore-docs-load-related-data">Loading related entities</see>.
/// </remarks>
public new virtual IQueryable<TRelatedEntity> Query()
{
InternalEntry.GetOrCreateCollection(Metadata, forMaterialization: true);
Expand All @@ -90,6 +103,9 @@ public CollectionEntry(InternalEntityEntry internalEntry, INavigation navigation
/// <summary>
/// The <see cref="EntityEntry{T}" /> of an entity this navigation targets.
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-entity-entries">Accessing tracked entities in EF Core</see>.
/// </remarks>
/// <param name="entity"> The entity to get the entry for. </param>
/// <value> An entry for an entity that this navigation targets. </value>
public new virtual EntityEntry<TRelatedEntity>? FindEntry(object entity)
Expand Down
Loading

0 comments on commit 73ad471

Please sign in to comment.