Code attribute to disable inclusion in help file

Jun 7, 2013 at 1:27 PM
Edited Jun 7, 2013 at 1:27 PM
Hi,

Is there a way (for example by adding an attribute in code) to skip certain method / constants / properties from getting included in the help file generated by SandCastle?

I know that I can do this by using ApiFilter, but I want to have this control through my source code file rather than through sandcastle project file.

For example, if my class has following method:
public class Foo
{
   [SkipInHelpFile]
   public void TrialMethodNotYetForPublic()
   {
   }
}
is there anything like SkipInHelpFile attribute?

Thanks in advance.

Regards,
  • Vikram Lele
Editor
Jun 7, 2013 at 10:14 PM
The <exclude /> tag can be used in XML comments to exclude members. These get translated to API filter entries at build time by SHFB. Bear in mind that the same behaviors apply. If used on an overloaded member, all related overloaded members are excluded as well.

Also, please note that this project has been discontinued and may not be monitored as frequently. For future questions or issues concerning Sandcastle or SHFB, post them over on the Sandcastle Help File Builder project's discussion page. Thanks.

Eric
Jun 8, 2013 at 5:55 AM
Edited Jun 8, 2013 at 5:55 AM
Thanks Eric. I will try that.

Also thanks for update on project status.

Regards,
Vikram