Skip to content

Commit

Permalink
Linking more conceptual docs from API docs
Browse files Browse the repository at this point in the history
Part of #17508
  • Loading branch information
ajcvickers committed Aug 20, 2021
1 parent bd4b505 commit a5409b8
Show file tree
Hide file tree
Showing 28 changed files with 489 additions and 2 deletions.
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTracking/ChangeTrackerExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ public static class ChangeTrackerExtensions
/// It is designed for debugging only and may change arbitrarily between releases.
/// </para>
/// </summary>
/// <remarks>
/// For more information, <see href="https://aka.ms/efcore-docs-change-tracking">EF Core change tracking</see>.
/// </remarks>
/// <param name="changeTracker"> The metadata item. </param>
/// <param name="options"> Options for generating the string. </param>
/// <param name="indent"> The number of indent spaces to use before each new line. </param>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/ChangeTrackingStrategy.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Indicates how the context detects changes to properties for an instance of the entity type.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-change-detection">Change detection and notifications</see>.
/// </remarks>
public enum ChangeTrackingStrategy
{
/// <summary>
Expand Down
179 changes: 177 additions & 2 deletions src/EFCore/DbContext.cs

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions src/EFCore/DbContextId.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ namespace Microsoft.EntityFrameworkCore
/// that it is easy to identify that multiple events are using the same or different context instances.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-dbcontext">
/// DbContext lifetime, configuration, and initialization</see>.
/// </remarks>
public readonly struct DbContextId
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbContextOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ namespace Microsoft.EntityFrameworkCore
/// <see cref="DbContext.OnConfiguring(DbContextOptionsBuilder)" /> or use a <see cref="DbContextOptionsBuilder" />
/// to create instances of this class and it is not designed to be directly constructed in your application code.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>.
/// </remarks>
public abstract class DbContextOptions : IDbContextOptions
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbContextOptionsBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ namespace Microsoft.EntityFrameworkCore
/// externally and passing it to the context constructor.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>.
/// </remarks>
public class DbContextOptionsBuilder : IDbContextOptionsBuilderInfrastructure
{
private DbContextOptions _options;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbContextOptionsBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ namespace Microsoft.EntityFrameworkCore
/// externally and passing it to the context constructor.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>.
/// </remarks>
/// <typeparam name="TContext"> The type of context to be configured. </typeparam>
public class DbContextOptionsBuilder<TContext> : DbContextOptionsBuilder
where TContext : DbContext
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbContextOptions`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ namespace Microsoft.EntityFrameworkCore
/// to create instances of this class and it is not designed to be directly constructed in your application code.
/// </summary>
/// <typeparam name="TContext"> The type of the context these options apply to. </typeparam>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>.
/// </remarks>
public class DbContextOptions<TContext> : DbContextOptions
where TContext : DbContext
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbFunctions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore
/// Provides CLR methods that get translated to database functions when used in LINQ to Entities queries.
/// The methods on this class are accessed via <see cref="EF.Functions" />.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-database-functions">Database functions</see>.
/// </remarks>
public sealed class DbFunctions
{
private DbFunctions()
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbFunctionsExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore
/// Provides CLR methods that get translated to database functions when used in LINQ to Entities queries.
/// The methods on this class are accessed via <see cref="EF.Functions" />.
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-database-functions">Database functions</see>.
/// </remarks>
// ReSharper disable once InconsistentNaming
public static class DbFunctionsExtensions
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/DbLoggerCategory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore
/// <see cref="IDiagnosticsLogger{TLoggerCategory}" /> to create a logger.
/// </para>
/// </summary>
/// <remarks>
/// For more information, see <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see>.
/// </remarks>
public static class DbLoggerCategory
{
/// <summary>
Expand Down
Loading

0 comments on commit a5409b8

Please sign in to comment.