DocumentedEntitiesOnlyPlugIn Class

public sealed class DocumentedEntitiesOnlyPlugIn : IPlugIn, 
	IDisposable

Public NotInheritable Class DocumentedEntitiesOnlyPlugIn
	Implements IPlugIn, IDisposable

public ref class DocumentedEntitiesOnlyPlugIn sealed : IPlugIn, 
	IDisposable

[<SealedAttribute>]
type DocumentedEntitiesOnlyPlugIn = 
    class
        interface IPlugIn
        interface IDisposable
    end

Inheritance

Object    DocumentedEntitiesOnlyPlugIn

Implements

IPlugIn, IDisposable

This plug-in is unique in that it runs both before and after the GenerateReflectionInfo step. This is necessary as we must remove any project-based API filter and generate a full set of API information in order to compare it to the XML comments member IDs. Once we have done that, we can generate an API filter and apply it by building the reflection information again.

Note that we are still constrained by the rules of the API filter. Specifically, if you exclude one member of an overloaded method set, all of them will be excluded. There is no getting around that rule.

In addition, since inherited documentation is generated after reflection data is generated, undocumented members of explicitly implemented interfaces will not be included. If you want them included, you must explicitly add an inheritdoc tag on those members.

To explicitly exclude a documented member, add the exclude XML comment tag to its comments. If placed on a type, it will exclude the entire type regardless of whether or not it has documented members. If placed on a NamespaceDoc class, it will exclude all types within the namespace regardless of whether or not they are documented. Note that namespace exclusions defined in the project namespace summaries will have no effect. You must either add a NamespaceDoc class for the excluded namespace or exclude all of its types.

Reference