fix: XML comment and generation fix (#588)

Finbuckle · Sep 17, 2022 · c1de82d · c1de82d
1 parent 398126c
commit c1de82d
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 13 deletions.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -12,6 +12,8 @@
         <SymbolPackageFormat>snupkg</SymbolPackageFormat>
         <PackageTags>finbuckle;multitenant;multitenancy;aspnet;aspnetcore;entityframework;entityframework-core;efcore</PackageTags>
         <PackageIcon>finbuckle-128x128.png</PackageIcon>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <NoWarn>CS1591</NoWarn>
     </PropertyGroup>
 
     <ItemGroup>

diff --git a/samples/net6.0/BasePathStrategySample/BasePathStrategySample.csproj b/samples/net6.0/BasePathStrategySample/BasePathStrategySample.csproj
@@ -7,7 +7,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Finbuckle.MultiTenant.AspNetCore" Version="6.6.1" />
+      <PackageReference Include="Finbuckle.MultiTenant.AspNetCore" Version="6.*" />
     </ItemGroup>
 
 </Project>
diff --git a/samples/net6.0/IdentitySample/IdentitySample.csproj b/samples/net6.0/IdentitySample/IdentitySample.csproj
@@ -14,8 +14,8 @@
         <PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="6.0.2" />
         <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="6.0.2" />
         <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="6.0.2" />
-        <PackageReference Include="Finbuckle.MultiTenant.AspNetCore" Version="6.6.1" />
-        <PackageReference Include="Finbuckle.MultiTenant.EntityFrameworkCore" Version="6.6.1" />
+        <PackageReference Include="Finbuckle.MultiTenant.AspNetCore" Version="6.*" />
+        <PackageReference Include="Finbuckle.MultiTenant.EntityFrameworkCore" Version="6.*" />
         <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.2" />
     </ItemGroup>
 

diff --git a/src/Finbuckle.MultiTenant.EntityFrameworkCore/Extensions/EntityTypeBuilderExtensions.cs b/src/Finbuckle.MultiTenant.EntityFrameworkCore/Extensions/EntityTypeBuilderExtensions.cs
@@ -38,7 +38,6 @@ private class ExpressionVariableScope
         /// Adds MultiTenant support for an entity. Call <see cref="IsMultiTenant" /> after
         /// <see cref="EntityTypeBuilder.HasQueryFilter" /> to merge query filters.
         /// </summary>
-        /// <typeparam name="T">The specific type of <see cref="EntityTypeBuilder"/></typeparam>
         /// <param name="builder">The typed EntityTypeBuilder instance.</param>
         /// <returns>A MultiTenantEntityTypeBuilder instance.</returns>
         public static MultiTenantEntityTypeBuilder IsMultiTenant(this EntityTypeBuilder builder)

diff --git a/src/Finbuckle.MultiTenant.EntityFrameworkCore/Extensions/EntityTypeExtensions.cs b/src/Finbuckle.MultiTenant.EntityFrameworkCore/Extensions/EntityTypeExtensions.cs
@@ -11,7 +11,7 @@ public static class EntityTypeExtensions
         /// Whether or not the <see cref="IEntityType"/> is configured as MultiTenant.
         /// </summary>
         /// <param name="entityType">The entity type to test for MultiTenant configuration.</param>
-        /// <returns><see cref="true"/> if the entity type has MultiTenant configuration, <see cref="false"/> if not.</returns>
+        /// <returns>Returns true if the entity type has MultiTenant configuration, false if not.</returns>
         public static bool IsMultiTenant(this IMutableEntityType? entityType)
         {
             while (entityType != null)

diff --git a/src/Finbuckle.MultiTenant/Abstractions/IMultiTenantStore.cs b/src/Finbuckle.MultiTenant/Abstractions/IMultiTenantStore.cs
@@ -14,23 +14,23 @@ namespace Finbuckle.MultiTenant
         /// <summary>
         /// Try to add the TTenantInfo to the store.
         /// </summary>
-        /// <param name="context"></param>
+        /// <param name="tenantInfo"></param>
         /// <returns></returns>
         Task<bool> TryAddAsync(TTenantInfo tenantInfo);
 
         /// <summary>
         /// Try to update the TTenantInfo in the store.
         /// </summary>
-        /// <param name="context"></param>
+        /// <param name="tenantInfo"></param>
         /// <returns></returns>
         Task<bool> TryUpdateAsync(TTenantInfo tenantInfo);
 
         /// <summary>
         /// Try to remove the TTenantInfo from the store.
         /// </summary>
-        /// <param name="id"></param>
+        /// <param name="tenantInfo"></param>
         /// <returns></returns>
-        Task<bool> TryRemoveAsync(string identifier);
+        Task<bool> TryRemoveAsync(string tenantInfo);
 
         /// <summary>
         /// Retrieve the TTenantInfo for a given identifier.

diff --git a/src/Finbuckle.MultiTenant/Options/MultiTenantOptionsFactory.cs b/src/Finbuckle.MultiTenant/Options/MultiTenantOptionsFactory.cs
@@ -13,6 +13,7 @@ namespace Finbuckle.MultiTenant.Options
     /// Implementation of IOptionsFactory.
     /// </summary>
     /// <typeparam name="TOptions">The type of options being requested.</typeparam>
+    /// <typeparam name="TTenantInfo">The type of the tenant info.</typeparam>
     public class MultiTenantOptionsFactory<TOptions, TTenantInfo> : IOptionsFactory<TOptions>
         where TOptions : class, new()
         where TTenantInfo : class, ITenantInfo, new()

diff --git a/src/Finbuckle.MultiTenant/Options/MultiTenantOptionsManager.cs b/src/Finbuckle.MultiTenant/Options/MultiTenantOptionsManager.cs
@@ -21,6 +21,7 @@ namespace Finbuckle.MultiTenant.Options
         /// Initializes a new instance with the specified options configurations.
         /// </summary>
         /// <param name="factory">The factory to use to create options.</param>
+        /// <param name="cache">The cache used for options.</param>
         public MultiTenantOptionsManager(IOptionsFactory<TOptions> factory, IOptionsMonitorCache<TOptions> cache)
         {
             _factory = factory;

diff --git a/...tityFrameworkCore.Test/MultiTenantEntityTypeBuilder/MultiTenantEntityTypeBuilderShould.cs b/...tityFrameworkCore.Test/MultiTenantEntityTypeBuilder/MultiTenantEntityTypeBuilderShould.cs
@@ -112,7 +112,7 @@ public void AdjustPrimaryKeyOnAdjustKey()
             {
                 var key = db.Model.FindEntityType(typeof(Post))?.GetKeys().ToList();
 
-                Assert.Single(key);
+                Assert.Single(key!);
                 Assert.Equal(2, key![0].Properties.Count);
                 Assert.Contains("PostId", key[0].Properties.Select(p => p.Name));
                 Assert.Contains("TenantId", key[0].Properties.Select(p => p.Name));
@@ -131,7 +131,7 @@ public void AdjustDependentForeignKeyOnAdjustPrimaryKey()
             {
                 var key = db.Model.FindEntityType(typeof(Post))?.GetForeignKeys().ToList();
 
-                Assert.Single(key);
+                Assert.Single(key!);
                 Assert.Equal(2, key![0].Properties.Count);
                 Assert.Contains("BlogId", key[0].Properties.Select(p => p.Name));
                 Assert.Contains("TenantId", key[0].Properties.Select(p => p.Name));
@@ -149,7 +149,7 @@ public void AdjustAlternateKeyOnAdjustKey()
             {
                 var key = db.Model.FindEntityType(typeof(Blog))?.GetKeys().Where(k => !k.IsPrimaryKey()).ToList();
 
-                Assert.Single(key);
+                Assert.Single(key!);
                 Assert.Equal(2, key![0].Properties.Count);
                 Assert.Contains("Url", key[0].Properties.Select(p => p.Name));
                 Assert.Contains("TenantId", key[0].Properties.Select(p => p.Name));
@@ -172,7 +172,7 @@ public void AdjustDependentForeignKeyOnAdjustAlternateKey()
             {
                 var key = db.Model.FindEntityType(typeof(Post))?.GetForeignKeys().ToList();
 
-                Assert.Single(key);
+                Assert.Single(key!);
                 Assert.Equal(2, key![0].Properties.Count);
                 Assert.Contains("Title", key[0].Properties.Select(p => p.Name));
                 Assert.Contains("TenantId", key[0].Properties.Select(p => p.Name));