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

Finish linking to conceptual docs #25983

Merged
merged 1 commit into from
Sep 14, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,17 @@ namespace Microsoft.EntityFrameworkCore.Design
/// Extension methods for adding Entity Framework Core design-time services to an
/// <see cref="IServiceCollection" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public static class DesignTimeServiceCollectionExtensions
{
/// <summary>
/// Adds the Entity Framework Core design-time services.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
/// <param name="services"> The <see cref="IServiceCollection" /> the services will be added to. </param>
/// <param name="reporter"> Used to report design-time messages. </param>
/// <param name="applicationServiceProviderAccessor"> An accessor to the application service provider. </param>
Expand Down Expand Up @@ -80,6 +86,9 @@ public static IServiceCollection AddEntityFrameworkDesignTimeServices(
/// <summary>
/// Adds services from the <see cref="DbContext" /> which are used at design time.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
/// <param name="services"> The <see cref="IServiceCollection" /> the services will be added to. </param>
/// <param name="context"> The <see cref="DbContext" /> the services will be added from. </param>
/// <returns> The <paramref name="services" />. This enables chaining additional method calls. </returns>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Design/ILanguageBasedService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ namespace Microsoft.EntityFrameworkCore.Design
/// <summary>
/// Represents a service that gets resolved based on the programming language it supports.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ILanguageBasedService
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Design/IPluralizer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore.Design
/// <summary>
/// Converts identifiers to the plural and singular equivalents.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IPluralizer
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate C# for creating <see cref="MigrationOperation" /> objects.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public class CSharpMigrationOperationGenerator : ICSharpMigrationOperationGenerator
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate C# code for migrations.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public class CSharpMigrationsGenerator : MigrationsCodeGenerator
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate C# code for creating an <see cref="IModel" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public class CSharpSnapshotGenerator : ICSharpSnapshotGenerator
{
private static readonly MethodInfo _hasAnnotationMethodInfo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate C# code for creating <see cref="MigrationOperation" /> objects.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ICSharpMigrationOperationGenerator
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate C# code for creating an <see cref="IModel" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ICSharpSnapshotGenerator
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate code for migrations.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IMigrationsCodeGenerator : ILanguageBasedService
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Selects an <see cref="IMigrationsCodeGenerator" /> service for a given programming language.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IMigrationsCodeGeneratorSelector
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Migrations/Design/IMigrationsScaffolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to scaffold new migrations.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IMigrationsScaffolder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Migrations/Design/MigrationsBundle.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Defines the entry point for Migrations bundles.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migration-bundles">EF Core migration bundles</see>.
/// </remarks>
public static class MigrationsBundle
{
private static string? _context;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to generate code for migrations.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public abstract class MigrationsCodeGenerator : IMigrationsCodeGenerator
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Migrations/Design/MigrationsScaffolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ namespace Microsoft.EntityFrameworkCore.Migrations.Design
/// <summary>
/// Used to scaffold new migrations.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-migrations">Database migrations</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public class MigrationsScaffolder : IMigrationsScaffolder
{
private readonly Type _contextType;
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Scaffolding/ICompiledModelCodeGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to generate code for compiled model metadata.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-compiled-models">EF Core compiled models</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ICompiledModelCodeGenerator : ILanguageBasedService
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Selects an <see cref="ICompiledModelCodeGenerator" /> service for given generation options.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-compiled-models">EF Core compiled models</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ICompiledModelCodeGeneratorSelector
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Scaffolding/ICompiledModelScaffolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to scaffold a compiled model from a model.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-compiled-models">EF Core compiled models</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface ICompiledModelScaffolder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Scaffolding/IModelCodeGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to generate code for a model.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IModelCodeGenerator : ILanguageBasedService
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Scaffolding/IModelCodeGeneratorSelector.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Selects an <see cref="IModelCodeGenerator" /> service for a given programming language.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IModelCodeGeneratorSelector
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Scaffolding/IReverseEngineerScaffolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to scaffold a model from a database schema.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-scaffolding">Reverse engineering (scaffolding) an existing database</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IReverseEngineerScaffolder
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Design/Scaffolding/IScaffoldingModelFactory.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to create an <see cref="IModel"/> from a <see cref="DatabaseModel"/>.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-scaffolding">Reverse engineering (scaffolding) an existing database</see>, and
/// <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public interface IScaffoldingModelFactory
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Design/Scaffolding/ModelCodeGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Scaffolding
/// <summary>
/// Used to generate code for a model.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-design-time-services">EF Core design-time services</see> for more information.
/// </remarks>
public abstract class ModelCodeGenerator : IModelCodeGenerator
{
/// <summary>
Expand Down
12 changes: 12 additions & 0 deletions src/EFCore.Proxies/ProxiesExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ public static class ProxiesExtensions
/// <see cref="ProxiesServiceCollectionExtensions.AddEntityFrameworkProxies" /> may be needed.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-notification-entities">Notification entities</see> for more information.
/// </remarks>
/// <param name="optionsBuilder">
/// The options builder, as passed to <see cref="DbContext.OnConfiguring" />
/// or exposed AddDbContext.
Expand Down Expand Up @@ -66,6 +69,9 @@ public static DbContextOptionsBuilder UseChangeTrackingProxies(
/// <see cref="ProxiesServiceCollectionExtensions.AddEntityFrameworkProxies" /> may be needed.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-notification-entities">Notification entities</see> for more information.
/// </remarks>
/// <typeparam name="TContext"> The <see cref="DbContext" /> type. </typeparam>
/// <param name="optionsBuilder">
/// The options builder, as passed to <see cref="DbContext.OnConfiguring" />
Expand Down Expand Up @@ -98,6 +104,9 @@ public static DbContextOptionsBuilder<TContext> UseChangeTrackingProxies<TContex
/// <see cref="ProxiesServiceCollectionExtensions.AddEntityFrameworkProxies" /> may be needed.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-lazy-loading">Lazy loading</see> for more information.
/// </remarks>
/// <param name="optionsBuilder">
/// The options builder, as passed to <see cref="DbContext.OnConfiguring" />
/// or exposed AddDbContext.
Expand Down Expand Up @@ -130,6 +139,9 @@ public static DbContextOptionsBuilder UseLazyLoadingProxies(
/// <see cref="ProxiesServiceCollectionExtensions.AddEntityFrameworkProxies" /> may be needed.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-lazy-loading">Lazy loading</see> for more information.
/// </remarks>
/// <typeparam name="TContext"> The <see cref="DbContext" /> type. </typeparam>
/// <param name="optionsBuilder">
/// The options builder, as passed to <see cref="DbContext.OnConfiguring" />
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Relational/Design/AnnotationCodeGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ namespace Microsoft.EntityFrameworkCore.Design
/// annotations that they understand.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</see>
/// for more information.
/// </remarks>
public class AnnotationCodeGenerator : IAnnotationCodeGenerator
{
private static readonly ISet<string> _ignoredRelationalAnnotations = new HashSet<string>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ namespace Microsoft.EntityFrameworkCore.Design
/// can handle the new scope, and that it does not cause issue for services that depend on it.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</see>
/// for more information.
/// </remarks>
public class EntityFrameworkRelationalDesignServicesBuilder : EntityFrameworkDesignServicesBuilder
{
/// <summary>
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Relational/Design/IAnnotationCodeGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ namespace Microsoft.EntityFrameworkCore.Design
/// have code generated (as opposed to being handled by convention) and then to generate
/// the code if needed.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-providers">Implementation of database providers and extensions</see>
/// for more information.
/// </remarks>
public interface IAnnotationCodeGenerator
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/BatchEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// The <see cref="DiagnosticSource" /> event payload for
/// <see cref="RelationalEventId" /> batch events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class BatchEventData : EventData
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// The <see cref="DiagnosticSource" /> event payload for events correlated with a <see cref="DbCommand" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CommandCorrelatedEventData : DbContextEventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/CommandEndEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// The <see cref="DiagnosticSource" /> event payload for
/// <see cref="RelationalEventId" /> command end events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CommandEndEventData : CommandEventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/CommandErrorEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// The <see cref="DiagnosticSource" /> event payload for <see cref="RelationalEventId.CommandError" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CommandErrorEventData : CommandEndEventData, IErrorEventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/CommandEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// The <see cref="DiagnosticSource" /> event payload for
/// <see cref="RelationalEventId" /> command events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CommandEventData : CommandCorrelatedEventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/CommandExecutedEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// The <see cref="DiagnosticSource" /> event payload for <see cref="RelationalEventId.CommandExecuted" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CommandExecutedEventData : CommandEndEventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Relational/Diagnostics/CommandSource.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// Enum used by <see cref="CommandEventData" />, and subclasses to indicate the
/// source of the <see cref="DbCommand" /> being used to execute the command.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public enum CommandSource
{
/// <summary>
Expand Down
Loading