Skip to content

Commit

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

Part of #17508

* Review updates
  • Loading branch information
ajcvickers authored Sep 4, 2021
1 parent c666392 commit 9702fc0
Show file tree
Hide file tree
Showing 283 changed files with 1,001 additions and 9 deletions.
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/CollectionCollectionBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class CollectionCollectionBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/CollectionCollectionBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="TLeftEntity"> One of the entity types in this relationship. </typeparam>
/// <typeparam name="TRightEntity"> One of the entity types in this relationship. </typeparam>
public class CollectionCollectionBuilder<TLeftEntity, TRightEntity> : CollectionCollectionBuilder
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/CollectionNavigationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class CollectionNavigationBuilder : IInfrastructure<IConventionForeignKeyBuilder?>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/CollectionNavigationBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="TEntity"> The entity type to be configured. </typeparam>
/// <typeparam name="TRelatedEntity"> The entity type that this relationship targets. </typeparam>
public class CollectionNavigationBuilder<TEntity, TRelatedEntity> : CollectionNavigationBuilder
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/DataBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Allows further configuration of model data.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class DataBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/DataBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Allows further configuration of model data.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="TEntity"> The entity type of the data. </typeparam>
public class DataBuilder<TEntity> : DataBuilder
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/DiscriminatorBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Provides a simple API surface for setting discriminator values.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class DiscriminatorBuilder : IConventionDiscriminatorBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/DiscriminatorBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Provides a simple API surface for setting discriminator values.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="TDiscriminator"> The type of the discriminator property. </typeparam>
public class DiscriminatorBuilder<TDiscriminator>
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/EntityTypeBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class EntityTypeBuilder : IInfrastructure<IConventionEntityTypeBuilder>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/EntityTypeBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="TEntity"> The entity type being configured. </typeparam>
public class EntityTypeBuilder<TEntity> : EntityTypeBuilder
where TEntity : class
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionAnnotatableBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Provides a simple API surface for setting discriminator values from conventions.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionDiscriminatorBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionEntityTypeBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionEntityTypeBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionForeignKeyBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionForeignKeyBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionIndexBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionIndexBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionKeyBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionKeyBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionModelBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionModelBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionNavigationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionNavigationBuilder : IConventionPropertyBaseBuilder
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// This interface is typically used by database providers (and other extensions). It is generally
/// not used in application code.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionOwnedEntityTypeBuilder
{
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionPropertyBaseBuilder : IConventionAnnotatableBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IConventionPropertyBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionPropertyBuilder : IConventionPropertyBaseBuilder
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionServicePropertyBuilder : IConventionPropertyBaseBuilder
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// not used in application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-conventions">Model building conventions</see> for more information.
/// </remarks>
public interface IConventionSkipNavigationBuilder : IConventionPropertyBaseBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IndexBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class IndexBuilder : IInfrastructure<IConventionIndexBuilder>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/IndexBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
// ReSharper disable once UnusedTypeParameter
public class IndexBuilder<T> : IndexBuilder
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Base class used for configuring an invertible relationship.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public abstract class InvertibleRelationshipBuilderBase : IInfrastructure<IConventionForeignKeyBuilder>
{
private readonly IReadOnlyList<Property>? _foreignKeyProperties;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/KeyBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class KeyBuilder : IInfrastructure<IConventionKeyBuilder>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/KeyBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
// ReSharper disable once UnusedTypeParameter
public class KeyBuilder<T> : KeyBuilder
{
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/NavigationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class NavigationBuilder : IInfrastructure<IConventionSkipNavigationBuilder?>, IInfrastructure<IConventionNavigationBuilder?>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/NavigationBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class NavigationBuilder<TSource, TTarget> : NavigationBuilder
where TSource : class
where TTarget : class
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnedEntityTypeBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class OwnedEntityTypeBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnedEntityTypeBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
/// <typeparam name="T"> The entity type being configured. </typeparam>
// ReSharper disable once UnusedTypeParameter
public class OwnedEntityTypeBuilder<T> : OwnedEntityTypeBuilder
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnedNavigationBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Provides a simple API for configuring a navigation to an owned entity type.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class OwnedNavigationBuilder : IInfrastructure<IConventionEntityTypeBuilder>
{
private InternalForeignKeyBuilder _builder;
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnedNavigationBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// <summary>
/// Provides a simple API for configuring a navigation to an owned entity type.
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> : OwnedNavigationBuilder
where TOwnerEntity : class
where TDependentEntity : class
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnershipBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// Provides a simple API for configuring an ownership.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class OwnershipBuilder : RelationshipBuilderBase
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/OwnershipBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// Provides a simple API for configuring an ownership.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class OwnershipBuilder<TEntity, TDependentEntity> : OwnershipBuilder
where TEntity : class
where TDependentEntity : class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class PropertiesConfigurationBuilder
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class PropertiesConfigurationBuilder<TProperty> : PropertiesConfigurationBuilder
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/PropertyBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class PropertyBuilder : IInfrastructure<IConventionPropertyBuilder>
{
/// <summary>
Expand Down
3 changes: 3 additions & 0 deletions src/EFCore/Metadata/Builders/PropertyBuilder`.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ namespace Microsoft.EntityFrameworkCore.Metadata.Builders
/// and it is not designed to be directly constructed in your application code.
/// </para>
/// </summary>
/// <remarks>
/// See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information.
/// </remarks>
public class PropertyBuilder<TProperty> : PropertyBuilder
{
/// <summary>
Expand Down
Loading

0 comments on commit 9702fc0

Please sign in to comment.