Question

How can I omit certain public classes or methods from being included in the documentation generated by The SandCastle Help File Builder?

Example: I have the following public class with two public methods:

/// <summary>
/// A simple test class.
/// </summary>
public class MyClass
{
    /// <summary>
    /// Method1s this instance.
    /// </summary>
    public void Method1()
    {
        // Do some operations here.
    }

    /// <summary>
    /// Method2s this instance.
    /// </summary>
    public void Method2()
    {
        // Do some operations here.
    }
}

When I generate the Help file out of this code using SandCastle Help File Builder, I want to ignore Method2.

Answer 1

In your project properties in Sandcastle Help File Builder GUI, edit the ApiFilter property (click the “…” button) and uncheck the members you don’t want to see in the help file.