search

ejball / XmlDocMarkdown

Generates Markdown from .NET XML documentation comments.
https://ejball.com/XmlDocMarkdown/
MIT License
102 stars 30 forks source link

Blacklist concept #57

Open lovettchris opened 4 years ago

lovettchris commented 4 years ago

I have some classes that I need to document because they are public, but they are intended for compiler use only, like custom implementations of AsyncControlledTaskMethodBuilder. So I need to document them for intellisense, but I'd like to strip them out of the docs.

I propose some sort of tag in the xml doc comment that signals XmlDocComment to ignore that class like:

/// <![CDATA[nodoc]]>

Alternative would be to use the following, but the downside to this is it has other implications:

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]

Or we have a completely separate --blacklist file that is input to the generator, but I would prefer something in the code since that is more maintainable.

mattbrailsford commented 4 years ago

I would also like to request this. I have code that I need to be discoverable in intellisense, but I don't want to show in the documentation. Something akin to docfx filter config would be really handy https://dotnet.github.io/docfx/tutorial/howto_filter_out_unwanted_apis_attributes.html or like @lovettchris a custom comment. 

/// <nodoc />