Update EF Extensions (#58)

Author: a-gubskiy

src/EntityFrameworkCore/BitzArt.XDoc.EntityFrameworkCore/Extensions/EntityTypeBuilderExtensions.cs

@@ -136,31 +136,46 @@ public static EntityTypeBuilder<TEntity> HasPropertyComment<TEntity, TProperty>(
 
         return entityTypeBuilder;
     }
-
+    
     /// <summary>
-    /// Adds comments to the entity type and all its properties using documentation from XDoc.
-    /// This method automatically maps XML comments from the entity class documentation to the database objects.
+    /// Configures XML documentation for the entity type being configured.
     /// </summary>
     /// <typeparam name="TEntity">The entity type being configured</typeparam>
     /// <param name="builder">The builder for the entity type</param>
     /// <param name="xdoc">The XDoc instance used to extract documentation</param>
     /// <returns>The same entity type builder instance so that multiple calls can be chained</returns>
-    public static EntityTypeBuilder<TEntity> MapXmlComments<TEntity>(
+    public static EntityTypeBuilder<TEntity> ConfigureEntityXmlDocumentation<TEntity>(
         this EntityTypeBuilder<TEntity> builder,
         XDoc xdoc)
         where TEntity : class
     {
         var entityType = builder.Metadata;
-
-        entityType.ConfigureEntityTypeComment(xdoc);
-
+        entityType.ConfigureEntityXmlDocumentation(xdoc);
+    
+        return builder;
+    }
+    
+    /// <summary>
+    /// Configures XML documentation for all properties of the entity type being configured.
+    /// </summary>
+    /// <typeparam name="TEntity">The entity type being configured</typeparam>
+    /// <param name="builder">The builder for the entity type</param>
+    /// <param name="xdoc">The XDoc instance used to extract documentation</param>
+    /// <returns>The same entity type builder instance so that multiple calls can be chained</returns>
+    public static EntityTypeBuilder<TEntity> ConfigurePropertiesXmlDocumentation<TEntity>(
+        this EntityTypeBuilder<TEntity> builder,
+        XDoc xdoc)
+        where TEntity : class
+    {
+        var entityType = builder.Metadata;
+    
         var properties = entityType.GetProperties();
-
+    
         foreach (var property in properties)
         {
-            entityType.ConfigureEntityPropertyComment(xdoc, property);
+            entityType.ConfigurePropertyXmlDocumentation(xdoc, property);
         }
-
+    
         return builder;
     }
 }

src/EntityFrameworkCore/BitzArt.XDoc.EntityFrameworkCore/Extensions/ModelBuilderExtensions.cs

@@ -20,7 +20,8 @@ public static ModelBuilder ConfigureComments(this ModelBuilder modelBuilder, XDo
 
         foreach (var entityType in entityTypes)
         {
-            entityType.ConfigureEntityComments(xDoc);
+            entityType.ConfigureEntityXmlDocumentation(xDoc);
+            entityType.ConfigurePropertiesXmlDocumentation(xDoc);
         }
 
         return modelBuilder;

src/EntityFrameworkCore/BitzArt.XDoc.EntityFrameworkCore/Extensions/MutableEntityTypeExtensions.cs

@@ -10,31 +10,34 @@ namespace BitzArt.XDoc;
 public static class MutableEntityTypeExtensions
 {
     /// <summary>
-    /// Configures an entity and all its properties with comments from XML documentation.
+    /// Configures XML documentation as comments for all properties of an entity type.
     /// </summary>
-    /// <param name="entityType">The entity type to configure.</param>
-    /// <param name="xDoc">The XDoc instance containing XML documentation.</param>
-    public static void ConfigureEntityComments(this IMutableEntityType entityType, XDoc xDoc)
+    /// <param name="entityType">The entity type whose properties should be configured with documentation.</param>
+    /// <param name="xDoc">The XDoc instance containing XML documentation information.</param>
+    /// <remarks>
+    /// This method iterates through all properties of the entity type and applies
+    /// XML documentation as comments to each property.
+    /// </remarks>
+    public static void ConfigurePropertiesXmlDocumentation(this IMutableEntityType entityType, XDoc xDoc)
     {
-        entityType.ConfigureEntityTypeComment(xDoc);
-
         var properties = entityType.GetProperties();
 
         foreach (var property in properties)
         {
-            entityType.ConfigureEntityPropertyComment(xDoc, property);
+            entityType.ConfigurePropertyXmlDocumentation(xDoc, property);
         }
     }
 
     /// <summary>
-    /// Configures an entity type with a comment from its XML documentation.
+    /// Configures XML documentation as a comment for an entity type.
     /// </summary>
-    /// <param name="entityType">The entity type to configure.</param>
-    /// <param name="xDoc">The XDoc instance containing XML documentation.</param>
+    /// <param name="entityType">The entity type to configure with documentation.</param>
+    /// <param name="xDoc">The XDoc instance containing XML documentation information.</param>
     /// <remarks>
     /// Comments are not applied to owned entities or entities without a table name.
+    /// If no XML documentation exists for the entity type, no comment is set.
     /// </remarks>
-    public static void ConfigureEntityTypeComment(this IMutableEntityType entityType, XDoc xDoc)
+    public static void ConfigureEntityXmlDocumentation(this IMutableEntityType entityType, XDoc xDoc)
     {
         var typeDocumentation = xDoc.Get(entityType.ClrType);
 
@@ -69,7 +72,7 @@ public static void ConfigureEntityTypeComment(this IMutableEntityType entityType
     /// <remarks>
     /// Comments are not applied to shadow properties or properties without documentation.
     /// </remarks>
-    public static void ConfigureEntityPropertyComment(this IMutableEntityType entityType, XDoc xDoc, IMutableProperty property)
+    public static void ConfigurePropertyXmlDocumentation(this IMutableEntityType entityType, XDoc xDoc, IMutableProperty property)
     {
         var isShadowProperty = property.IsShadowProperty();
 

src/EntityFrameworkCore/BitzArt.XDoc.EntityFrameworkCore/Extensions/OwnedNavigationBuilderExtensions.cs

@@ -8,30 +8,51 @@ namespace BitzArt.XDoc;
 public static class OwnedNavigationBuilderExtensions
 {
     /// <summary>
-    /// Maps XML comments from an XDoc instance to an entity type and its properties.
+    /// Configures XML documentation for the entity type represented by the owned navigation builder.
     /// </summary>
     /// <typeparam name="TOwnerEntity">The type of the owner entity.</typeparam>
     /// <typeparam name="TDependentEntity">The type of the dependent entity.</typeparam>
-    /// <param name="builder">The owned navigation builder to extend.</param>
-    /// <param name="xdoc">The XDoc instance containing XML comments to be mapped.</param>
-    /// <returns>The same builder instance so that multiple calls can be chained.</returns>
-    public static OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> MapXmlComments<TOwnerEntity, TDependentEntity>(
-        this OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> builder, XDoc xdoc)
+    /// <param name="builder">The owned navigation builder to configure.</param>
+    /// <param name="xdoc">The XML documentation container.</param>
+    /// <returns>The same builder instance so that multiple configuration calls can be chained.</returns>
+    public static OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> ConfigureEntityXmlDocumentation<TOwnerEntity,
+        TDependentEntity>(
+        this OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> builder,
+        XDoc xdoc)
         where TOwnerEntity : class
         where TDependentEntity : class
     {
-        var entityType = builder.Metadata.DeclaringEntityType;
+        var entityType = builder.OwnedEntityType;
+
+        entityType.ConfigureEntityXmlDocumentation(xdoc);
 
-        entityType.ConfigureEntityTypeComment(xdoc);
+        return builder;
+    }
+
+    /// <summary>
+    /// Configures XML documentation for all properties of the entity type represented by the owned navigation builder.
+    /// </summary>
+    /// <typeparam name="TOwnerEntity">The type of the owner entity.</typeparam>
+    /// <typeparam name="TDependentEntity">The type of the dependent entity.</typeparam>
+    /// <param name="builder">The owned navigation builder to configure.</param>
+    /// <param name="xdoc">The XML documentation container.</param>
+    /// <returns>The same builder instance so that multiple configuration calls can be chained.</returns>
+    public static OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> ConfigurePropertiesXmlDocumentation<
+        TOwnerEntity, TDependentEntity>(
+        this OwnedNavigationBuilder<TOwnerEntity, TDependentEntity> builder,
+        XDoc xdoc)
+        where TOwnerEntity : class
+        where TDependentEntity : class
+    {
+        var entityType = builder.Metadata.DeclaringEntityType;
 
         var properties = entityType.GetProperties();
 
         foreach (var property in properties)
         {
-            entityType.ConfigureEntityPropertyComment(xdoc, property);
+            entityType.ConfigurePropertyXmlDocumentation(xdoc, property);
         }
 
         return builder;
     }
-
 }