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
.
(This is an update, since the UI seems to have changed since Thomas Levesque posted his comment. It is also different than some info I've found other places online.)
In the latest version of SandCastle, as of May 31, 2014, you have to go through 3 steps to get there.
From there, you will find the list of API entries. You can individually deselect classes, namespaces, and items inside a class (properties, fields, methods).
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.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With