fix: change ExtendedSymbolKind to flags enum

dotnet · Jan 30, 2024 · 3fc575b · 3fc575b
1 parent 455ee29
commit 3fc575b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 15 deletions.
diff --git a/src/Docfx.Dotnet/Filters/ConfigFilterRuleItemUnion.cs b/src/Docfx.Dotnet/Filters/ConfigFilterRuleItemUnion.cs
@@ -54,7 +54,7 @@ public ConfigFilterRuleItem Rule
             }
 
             // If kind is not specified for exclude. Set `ExtendedSymbolKind.Type` as default kind.
-            Exclude.Kind ??= ExtendedSymbolKind.Type;
+            Exclude.Kind ??= ExtendedSymbolKind.Type | ExtendedSymbolKind.Member;
 
             return Exclude;
         }

diff --git a/src/Docfx.Dotnet/Filters/ExtendedSymbolKind.cs b/src/Docfx.Dotnet/Filters/ExtendedSymbolKind.cs
@@ -3,23 +3,30 @@
 
 namespace Docfx.Dotnet;
 
+[Flags]
 internal enum ExtendedSymbolKind
 {
-    Assembly = 0x100,
-    Namespace = 0x110,
-    Type = 0x120,
-    Class,
-    Struct,
-    Enum,
-    Interface,
-    Delegate,
-    Member = 0x200,
-    Event,
-    Field,
-    Method,
-    Property,
+#pragma warning disable format
+    Assembly  = 1 << 1,
+    Namespace = 1 << 2,
+    // Type
+    Class     = 1 << 3,
+    Struct    = 1 << 4,
+    Enum      = 1 << 5,
+    Interface = 1 << 6,
+    Delegate  = 1 << 7,
+    // Member
+    Event     = 1 << 8,
+    Field     = 1 << 9,
+    Method    = 1 << 10,
+    Property  = 1 << 11,
+#pragma warning restore format
+
+    Type = Class | Struct | Enum | Interface | Delegate,
+    Member = Event | Field | Method | Property,
 }
 
+
 internal static class ExtendedSymbolKindHelper
 {
     public static bool Contains(this ExtendedSymbolKind kind, SymbolFilterData symbol)
@@ -30,6 +37,6 @@ public static bool Contains(this ExtendedSymbolKind kind, SymbolFilterData symbo
         {
             return false;
         }
-        return (kind & k.Value) == kind;
+        return (kind & k.Value) > 0;
     }
 }
diff --git a/test/Docfx.Dotnet.Tests/ApiFilterUnitTest.cs b/test/Docfx.Dotnet.Tests/ApiFilterUnitTest.cs
@@ -359,6 +359,12 @@ public class NestedClass : Class1
         Assert.Equal("Microsoft.DevDiv.SpecialCase.NestedClass", nestedClass.Name);
     }
 
+    [Fact]
+    public void TestExtendedSymbolKindFlags()
+    {
+        Assert.True((ExtendedSymbolKind.Type | ExtendedSymbolKind.Member).Contains(new SymbolFilterData { Kind = ExtendedSymbolKind.Interface }));
+    }
+
     private static MetadataItem Verify(string code, ExtractMetadataConfig config = null, DotnetApiOptions options = null)
     {
         var compilation = CompilationHelper.CreateCompilationFromCSharpCode(code, "test.dll");