I have created a custom attribute called "Unsupported" and placed that attribute on certain interfaces, properties, and methods.
Ideally, I would like Sandcastle to ignore items marked wtih this attribute. Is there a simple way to accomplish this? Perhaps something in one of the transform files?
Thanks for any help!
Ken
In the current CTP, there isn't a way to exclude public items. Support for the <exclude/> XML comment tag is in the works for Sandcastle though.
Eric
This is correct and we will address custom tags such as <exclude /> in our October RTW build.
Anand..
Ken
We are planning at the end of October as we have monthly release cycles. However we will do our best to get it out early.
Anand..
I just read the blog description of the November 2006 Sandcastle CTP, and saw that it supports "Excluding (Ripping) namespaces, types, and members (Configured through MrefBuilder.config)". Is this the same as (or in lieu of, or a predecessor to) supporting the <exclude /> tag? (I'm a newbie who has only used NDoc, and more recently, Eric Woodruff's excellent Sandcastle Help File Builder, so I'm not directly familiar with MrefBuilder.config.)
NDoc also supported the following attribute-based technique for excluding a public method or class:
[EditorBrowsable(EditorBrowsableState::Never)]
I do not see support for this attribute in the October Sandcastle and corresponding SHFB. Will you consider such support (if it's not already in the November update)?
Many thanks, by the way, for supporting the easy transition from NDoc to Sandcastle!!
Sue
Although still present for backward compatability, the EditorBrowsableFilter property in NDoc was replaced by the <exclude/> tag so you should start using it to mark items that you don't want to appear in the docs. I don't know if or how the ripping feature will tie into support for <exclude/> in Sandcastle. Once I get some more details on how the ripping stuff works, I can build support for <exclude/> into the help file builder by having it scan the XML comments files for entries with that tag and specifying them in MRefBuilder.config so that it can exclude them.
Eric
Just out of curiosity, and because I'm still quite new to all this...is there a reason that the EditorBrowsableFilter property was superseded? It was handy to be able to use a single standard attribute to suppress an item both from IntelliSense and from the generated documentation.
At any rate, I look forward to your support for the <exclude/> tags!
Many thanks,
Sue
I can't say for sure but the note in the documentation for that property says that enabling it might result in invalid links in the documentation. I assume <exclude/> is just a safer way of doing it.
Eric
