0

Management of attributes

lauraj

11 March 2008 16:02

None

Follow

I am documenting .NET assemblies. I've just noticed that those members decorated with [EditorBrowsable(EditorBrowsableState.Never)] do not get included in the documentation generated with Document!X. Talked that over with the team & ideally they would like to generate a separate help file with just those members (for use primarily by support and by the few customers for whom these members exist).

In addition, they'd like to move those classes & members decorated with [ObsoleteAttribute] into this new help file. At present, the obsolete members appear in the Document!X generated help with nothing to show they are obsolete except for the appearance of [ObsoleteAttribute] in the syntax section.

So in short, I need to do two things:

- (in my existing Doc!X project) Turn off classes & members with [ObsoleteAttribute] in my Document!X project. If I've got to, I can do this manually on the Included Modules screen, but obviously that's a maintenance nightmare; I'm hoping there is an easier way.

- (in my new project) Turn on classes & members with EditorBrowsableState.Never. This is the important one, in that I've got no workaround for this -- I don't know how to make these classes & members show up at all.

Thanks for any assistance!

- LauraJ

• Facebook
• Twitter
• LinkedIn

6 comments

• 0
  
  lauraj 11 March 2008 16:42

  OK, I've just found the answer to my second question: On the Filters page, there's a check box for "Exclude members marked with the .NET EditorBrowsable(Never) attribute".

  Very straightforward, my only complaint is that searching in the Document!X help didn't turn up anything on this switch. ;->

• 0
  
  lauraj 28 March 2008 11:27

  I'm still wondering if there's any way to turn off members with [ObsoleteAttribute]. I've tried various ways to do this with the "Include filter/Exclude filter" buttons on the Microsoft .NET Options page, but these filters seem to have no effect and again, there's no mention of them in the documentation.

   Anybody???

• 0
  
  Richard Sloggett 31 March 2008 04:24

  Include filter / Exclude filter can only be used to filter by name. It's not possible to filter by [ObsoleteAttribute] at present I'm afraid - this seems like a good idea though and I've logged it as a suggestion for a future update.

• 0
  
  Derek 07 February 2012 18:09

• 0
  
  Richard Sloggett 07 February 2012 18:16

  Looks like your post came through blank - can you repost your follow up?

• 0
  
  Richard Sloggett 14 October 2012 21:16

  For the benefit of anyone coming across this post, this feature has now been implemented in our 2012.1 version - just enable the obsolete filter on the .NET Filters page in the Build Profile editor.