in
Innovasys Logo

Management of attributes

Last post 03-31-2008 4:24 AM by Richard Sloggett (Innovasys). 3 replies.
Page 1 of 1 (4 items)
Sort Posts: Previous Next
  • 03-11-2008 4:02 PM

    • lauraj
    • Top 50 Contributor
    • Joined on 06-26-2007
    • Posts 5

    Management of attributes

    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

  • 03-11-2008 4:42 PM In reply to

    • lauraj
    • Top 50 Contributor
    • Joined on 06-26-2007
    • Posts 5

    Re: Management of attributes

    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. ;->

  • 03-28-2008 11:27 AM In reply to

    • lauraj
    • Top 50 Contributor
    • Joined on 06-26-2007
    • Posts 5

    Re: Management of attributes

    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???

  • 03-31-2008 4:24 AM In reply to

    Re: Management of attributes

    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.

    Richard Sloggett
    Innovasys
    http://www.innovasys.com
Page 1 of 1 (4 items)