Skip to content

Commit

Permalink
More links to conceptual docs (#25962)
Browse files Browse the repository at this point in the history
* More links to conceptual docs

Part of #17508

* Remove hyphens from lazy-loading.
  • Loading branch information
ajcvickers committed Sep 11, 2021
1 parent 64ab712 commit f01b70d
Show file tree
Hide file tree
Showing 113 changed files with 1,633 additions and 42 deletions.
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/BackingFieldAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Names the backing field associated with this property or navigation property.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Property)]
public sealed class BackingFieldAttribute : Attribute
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace Microsoft.EntityFrameworkCore.ChangeTracking
/// For WPF data binding use an ObservableCollection rather than an instance of this class.
/// </para>
/// </summary>
/// <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>
public class ObservableCollectionListSource<T> : ObservableCollection<T>, IListSource
where T : class
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/CommentAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Marks a class, property or field with a comment to be set on the corresponding database table or column.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property | AttributeTargets.Field)]
public sealed class CommentAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/DbFunctionAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore
/// Maps a static CLR method to a database function so that the CLR method may be used in LINQ queries.
/// By convention uses the .NET method name as name of the database function and the default schema.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-database-functions">Database functions</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Method)]
#pragma warning disable CA1813 // Avoid unsealed attributes
// Already shipped unsealed
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/EntityTypeConfigurationAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Specifies the configuration type for the entity type.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Class)]
public sealed class EntityTypeConfigurationAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/IndexAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Specifies an index to be generated in the database.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
public sealed class IndexAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/Infrastructure/ILazyLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ namespace Microsoft.EntityFrameworkCore.Infrastructure
/// The implementation does not need to be thread-safe.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-lazy-loading">Lazy loading</see> for more information.
/// </remarks>
public interface ILazyLoader : IDisposable
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,17 @@ namespace Microsoft.EntityFrameworkCore.Infrastructure
/// Extension methods for the <see cref="ILazyLoader" /> service that make it more
/// convenient to use from entity classes.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-lazy-loading">Lazy loading</see> for more information.
/// </remarks>
public static class LazyLoaderExtensions
{
/// <summary>
/// Loads a navigation property if it has not already been loaded.
/// </summary>
/// <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>
/// <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>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/KeylessAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Marks a type as keyless entity.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Class)]
public sealed class KeylessAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/ObservableCollectionExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Extension methods for <see cref="ObservableCollection{T}" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-local-views">Local views of tracked entities in EF Core</see> for more information.
/// </remarks>
public static class ObservableCollectionExtensions
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/OwnedAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Marks a type as owned. All references to this type will be configured as owned entity types.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Class)]
public sealed class OwnedAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/PrecisionAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore
/// For example, if the property is a <see cref="decimal" />
/// then this is the maximum number of digits.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class PrecisionAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/Query/NotParameterizedAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore.Query
/// <summary>
/// Signals that custom LINQ operator parameter should not be parameterized during query compilation.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-query">Querying data with EF Core</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Parameter)]
public sealed class NotParameterizedAttribute : Attribute
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Abstractions/UnicodeAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Configures the property as capable of persisting unicode characters.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public sealed class UnicodeAttribute : Attribute
{
Expand Down
4 changes: 4 additions & 0 deletions src/EFCore.Cosmos/Diagnostics/CosmosEventId.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// behavior of warnings.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
public static class CosmosEventId
{
// Warning: These values must not change between releases.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// A <see cref="DiagnosticSource" /> event payload class for Cosmos item command executed events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CosmosItemCommandExecutedEventData : EventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Cosmos/Diagnostics/CosmosQueryEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// A <see cref="DiagnosticSource" /> event payload class for Cosmos query events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CosmosQueryEventData : EventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Cosmos/Diagnostics/CosmosQueryExecutedEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// A <see cref="DiagnosticSource" /> event payload class for Cosmos query events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CosmosQueryExecutedEventData : EventData
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore.Cosmos/Diagnostics/CosmosReadItemEventData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Diagnostics
/// <summary>
/// A <see cref="DiagnosticSource" /> event payload class for Cosmos read-item events.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-diagnostics">Logging, events, and diagnostics</see> for more information.
/// </remarks>
public class CosmosReadItemEventData : EventData
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ public static class CosmosDatabaseFacadeExtensions
/// <summary>
/// Gets the underlying <see cref="CosmosClient" /> for this <see cref="DbContext" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <param name="databaseFacade"> The <see cref="DatabaseFacade" /> for the context. </param>
/// <returns> The <see cref="CosmosClient" /> </returns>
public static CosmosClient GetCosmosClient(this DatabaseFacade databaseFacade)
Expand Down Expand Up @@ -51,6 +54,9 @@ private static TService GetService<TService>(IInfrastructure<IServiceProvider> d
/// provider to use as part of configuring the context.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <param name="database"> The facade from <see cref="DbContext.Database" />. </param>
/// <returns> <see langword="true" /> if the Cosmos provider is being used. </returns>
public static bool IsCosmos(this DatabaseFacade database)
Expand Down
20 changes: 20 additions & 0 deletions src/EFCore.Cosmos/Extensions/CosmosDbContextOptionsExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,19 @@ namespace Microsoft.EntityFrameworkCore
/// <summary>
/// Cosmos-specific extension methods for <see cref="DbContextOptionsBuilder" />.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
public static class CosmosDbContextOptionsExtensions
{
/// <summary>
/// Configures the context to connect to an Azure Cosmos database.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <typeparam name="TContext"> The type of context to be configured. </typeparam>
/// <param name="optionsBuilder"> The builder being used to configure the context. </param>
/// <param name="accountEndpoint"> The account end-point to connect to. </param>
Expand All @@ -41,6 +49,10 @@ public static DbContextOptionsBuilder<TContext> UseCosmos<TContext>(
/// <summary>
/// Configures the context to connect to an Azure Cosmos database.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <param name="optionsBuilder"> The builder being used to configure the context. </param>
/// <param name="accountEndpoint"> The account end-point to connect to. </param>
/// <param name="accountKey"> The account key. </param>
Expand Down Expand Up @@ -77,6 +89,10 @@ public static DbContextOptionsBuilder UseCosmos(
/// <summary>
/// Configures the context to connect to an Azure Cosmos database.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <typeparam name="TContext"> The type of context to be configured. </typeparam>
/// <param name="optionsBuilder"> The builder being used to configure the context. </param>
/// <param name="connectionString"> The connection string of the database to connect to. </param>
Expand All @@ -98,6 +114,10 @@ public static DbContextOptionsBuilder<TContext> UseCosmos<TContext>(
/// <summary>
/// Configures the context to connect to an Azure Cosmos database.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-dbcontext-options">Using DbContextOptions</see>, and
/// <see href="https://aka.ms/efcore-docs-cosmos">Accessing Azure Cosmos DB with EF Core</see> for more information.
/// </remarks>
/// <param name="optionsBuilder"> The builder being used to configure the context. </param>
/// <param name="connectionString"> The connection string of the database to connect to. </param>
/// <param name="databaseName"> The database name. </param>
Expand Down
Loading

0 comments on commit f01b70d

Please sign in to comment.