fix(NRE): Fix another small bug

unchase · Aug 26, 2021 · 7d07e99 · 7d07e99
1 parent b67a264
commit 7d07e99
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 28 deletions.
diff --git a/src/Unchase.Swashbuckle.AspNetCore.Extensions/Extensions/SwaggerGenOptionsExtensions.cs b/src/Unchase.Swashbuckle.AspNetCore.Extensions/Extensions/SwaggerGenOptionsExtensions.cs
@@ -106,7 +106,7 @@ public static SwaggerGenOptions IncludeXmlCommentsWithRemarks(
         {
             swaggerGenOptions.IncludeXmlComments(xmlDocFactory, includeControllerXmlComments);
 
-            var distinctExcludedTypes = excludedTypes?.Distinct().ToArray();
+            var distinctExcludedTypes = excludedTypes?.Distinct().ToArray() ?? new Type[] { };
 
             var xmlDoc = xmlDocFactory();
             swaggerGenOptions.ParameterFilter<XmlCommentsWithRemarksParameterFilter>(xmlDoc, distinctExcludedTypes);
@@ -214,7 +214,7 @@ public static SwaggerGenOptions IncludeXmlCommentsFromInheritDocs(
                     })
                 .ToDictionary(x => x.Name, x => x.Cref);
 
-            var distinctExcludedTypes = excludedTypes?.Distinct().ToArray();
+            var distinctExcludedTypes = excludedTypes?.Distinct().ToArray() ?? new Type[] { };
             swaggerGenOptions.ParameterFilter<InheritDocParameterFilter>(documents, inheritedDocs, includeRemarks, distinctExcludedTypes);
             swaggerGenOptions.RequestBodyFilter<InheritDocRequestBodyFilter>(documents, inheritedDocs, includeRemarks, distinctExcludedTypes);
             swaggerGenOptions.SchemaFilter<InheritDocSchemaFilter>(documents, inheritedDocs, includeRemarks, distinctExcludedTypes);

diff --git a/src/Unchase.Swashbuckle.AspNetCore.Extensions/Extensions/XmlCommentsExtensions.cs b/src/Unchase.Swashbuckle.AspNetCore.Extensions/Extensions/XmlCommentsExtensions.cs
@@ -17,24 +17,38 @@ internal static class XmlCommentsExtensions
 
         internal static Type GetTargetRecursive(this Type type, Dictionary<string, string> inheritedDocs, string cref)
         {
-            var target = GetTarget(type, cref);
+            var targets = GetTargets(type, cref);
 
-            if (target == null)
+            if (targets.Any() != true)
             {
                 return null;
             }
 
-            string targetMemberName = XmlCommentsNodeNameHelper.GetMemberNameForType(target);
-
-            if (inheritedDocs.ContainsKey(targetMemberName))
+            foreach (var target in targets)
             {
-                return GetTarget(target, inheritedDocs[targetMemberName]);
+                if (target == null)
+                {
+                    continue;
+                }
+
+                string targetMemberName = XmlCommentsNodeNameHelper.GetMemberNameForType(target);
+                if (!string.IsNullOrWhiteSpace(targetMemberName))
+                {
+                    if (inheritedDocs.ContainsKey(targetMemberName))
+                    {
+                        return GetTargetRecursive(target, inheritedDocs, inheritedDocs[targetMemberName]);
+                    }
+                    else
+                    {
+                        return target;
+                    }
+                }
             }
 
-            return target;
+            return null;
         }
 
-        private static Type GetTarget(Type type, string cref)
+        private static Type[] GetTargets(Type type, string cref)
         {
             var targets = type.GetInterfaces();
             if (type.BaseType != typeof(object))
@@ -49,34 +63,47 @@ private static Type GetTarget(Type type, string cref)
 
                 if (crefTarget != null)
                 {
-                    return crefTarget;
+                    return new[] { crefTarget };
                 }
             }
 
-            // We use the last since that will be our base class or the "nearest" implemented interface.
-            return targets.LastOrDefault();
+            return targets.ToArray();
         }
 
         internal static MemberInfo GetTargetRecursive(this MemberInfo memberInfo, Dictionary<string, string> inheritedDocs, string cref)
         {
-            var target = GetTarget(memberInfo, cref);
+            var targets = GetTargets(memberInfo, cref);
 
-            if (target == null)
+            if (targets.Any() != true)
             {
                 return null;
             }
 
-            string targetMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(target);
-
-            if (inheritedDocs.ContainsKey(targetMemberName))
+            foreach (var target in targets)
             {
-                return GetTarget(target, inheritedDocs[targetMemberName]);
+                if (target == null)
+                {
+                    continue;
+                }
+
+                string targetMemberName = XmlCommentsNodeNameHelper.GetMemberNameForFieldOrProperty(target);
+                if (!string.IsNullOrWhiteSpace(targetMemberName))
+                {
+                    if (inheritedDocs.ContainsKey(targetMemberName))
+                    {
+                        return GetTargetRecursive(target, inheritedDocs, inheritedDocs[targetMemberName]);
+                    }
+                    else
+                    {
+                        return target;
+                    }
+                }
             }
 
-            return target;
+            return null;
         }
 
-        private static MemberInfo GetTarget(MemberInfo memberInfo, string cref)
+        private static MemberInfo[] GetTargets(MemberInfo memberInfo, string cref)
         {
             var type = memberInfo.DeclaringType ?? memberInfo.ReflectedType;
 
@@ -103,12 +130,11 @@ private static MemberInfo GetTarget(MemberInfo memberInfo, string cref)
 
                 if (crefTarget != null)
                 {
-                    return crefTarget;
+                    return new[] { crefTarget };
                 }
             }
 
-            // We use the last since that will be our base class or the "nearest" implemented interface.
-            return targets.LastOrDefault();
+            return targets.ToArray();
         }
 
         internal static void ApplyPropertyComments(

diff --git a/src/Unchase.Swashbuckle.AspNetCore.Extensions/Filters/InheritDocSchemaFilter.cs b/src/Unchase.Swashbuckle.AspNetCore.Extensions/Filters/InheritDocSchemaFilter.cs
@@ -78,6 +78,11 @@ public void Apply(OpenApiSchema schema, SchemaFilterContext context)
                 string cref = _inheritedDocs[memberName];
                 var target = context.Type.GetTargetRecursive(_inheritedDocs, cref);
 
+                if (target == null)
+                {
+                    return;
+                }
+
                 var targetXmlNode = XmlCommentsExtensions.GetMemberXmlNode(XmlCommentsNodeNameHelper.GetMemberNameForType(target), _documents);
                 var summaryNode = targetXmlNode?.SelectSingleNode(SummaryTag);
 

diff --git a/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj b/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj
@@ -14,9 +14,9 @@
     <NeutralLanguage></NeutralLanguage>
     <LangVersion>7.3</LangVersion>
     <PackageIconUrl>https://github.com/unchase/Unchase.Swashbuckle.AspNetCore.Extensions/blob/master/assets/icon.png?raw=true</PackageIconUrl>
-    <Version>2.6.4</Version>
-    <AssemblyVersion>2.6.4.0</AssemblyVersion>
-    <FileVersion>2.6.4.0</FileVersion>
+    <Version>2.6.5</Version>
+    <AssemblyVersion>2.6.5.0</AssemblyVersion>
+    <FileVersion>2.6.5.0</FileVersion>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <DocumentationFile>Unchase.Swashbuckle.AspNetCore.Extensions.xml</DocumentationFile>
   </PropertyGroup>

diff --git a/test/WebApi3.1-Swashbuckle/Startup.cs b/test/WebApi3.1-Swashbuckle/Startup.cs
@@ -42,7 +42,7 @@ public void ConfigureServices(IServiceCollection services)
 
                 // if you want to add xml comments from inheritdocs (from summary and remarks) into the swagger documentation, add:
                 // you can exclude remarks for concrete types
-                options.IncludeXmlCommentsFromInheritDocs(includeRemarks: true, excludedTypes: typeof(string));
+                options.IncludeXmlCommentsFromInheritDocs(includeRemarks: true);
 
                 // options.IncludeXmlCommentsWithRemarks(filePath: xmlFilePath, includeControllerXmlComments: false, () => new[] { typeof(InnerEnum) });