DocFX - 无法从 API 文档中过滤掉公共方法

Question

I have the following method in my class library that I want to hide from API documentation:

namespace com.contoso.myns
{
    public class myclass
    {
        public static string CreateSomething()
        {
            //Do Stuff
        }
    }
}

I followed the DocFX Tutorial for filtering API documentation to create filterConfig.yml . In that file I have the following:

- exclude:
    uidRegex: '^com\.contoso\.myns\.myclass\.Create[^.]+$'
    type: Method

However, the method is still appearing in my documentation.

Please note:

• I have other filters defined in filterConfig.yml which are working as-expected, so the file is being picked up and properly parsed by DocFX.
• I tested the regex pattern (^com.contoso.myns.myclass.Create[^.]+$) using this regex tester and it does match the fully-qualified name of the method I want to exclude.

Any help would be greatly appreciated.

Answer 1

The pattern to match a method name shouldn't contain the entire path from the namespace; just the method name itself:

- exclude:
    uidRegex: 'CreateSomething$'
    type: Method