This project has moved and is read-only. For the latest updates, please go here.

Filtering on Custom Atrtibutes

Topics: Developer Forum
Jun 26, 2013 at 4:26 PM
Edited Jun 26, 2013 at 4:26 PM
Hi, I have a set of classes that I expose to IronPython through custom attributes. For example:
/// <summary>
/// Gets a formatted "[0xXXXX,0xXX]" string for the entry 
/// </summary>
/// <returns>The formatted hex name of the entry</returns>
[Help("Get a formatted '[0xXXXX,0xXX]' string for the entry")]
[Prototype("string ToHexName()")]
public string ToHexName()  {
    return String.Format("[0x{0:X4},0x{1:X2}]", Index, Subindex);
How can I get SandCastle to exclude everything by default and only include properties, methods, events, etc. with the Help attribute?

Note that I don't want to use the text from the Help attribute - just use it to generate a filter.

The Help attribute is defined in one of the core assemblies of my project and used in all the other assemblies.

Thanks, Andy
Jun 26, 2013 at 8:30 PM
There is no way to do that currently. You could write a plug-in to remove members from the reflection information file based on the attributes defined on them. The only other way to do it right now is to manage the API filter manually by excluding everything and adding back just the members you want.