Click or drag to resize

DocumentationProvider Class



A class used to provide XML documentation to the compiler for members from metadata. A custom implementation of this class should be returned from a DocumentationResolver to provide XML documentation comments from custom caches or locations.
Inheritance Hierarchy

Namespace:  Microsoft.CodeAnalysis
Assembly:  Microsoft.CodeAnalysis (in Microsoft.CodeAnalysis.dll) Version: 2.3.0-dev-56735-00. Commit Hash: <developer build>
Syntax
public abstract class DocumentationProvider

The DocumentationProvider type exposes the following members.

Constructors
  NameDescription
Protected methodDocumentationProvider
Initializes a new instance of the DocumentationProvider class
Top
Properties
  NameDescription
Public propertyStatic memberDefault
Top
Methods
  NameDescription
Public methodEquals
DocumentationProviders are compared when determining whether an AssemblySymbol can be reused. Hence, if multiple instances can represent the same documentation, it is imperative that Equals (and GetHashCode) be overridden to capture this fact. Otherwise, it is possible to end up with multiple AssemblySymbols for the same assembly, which plays havoc with the type hierarchy.
Protected methodGetDocumentationForSymbol
Fetches a documentation comment for the given member ID.
Public methodGetHashCode
DocumentationProviders are compared when determining whether an AssemblySymbol can be reused. Hence, if multiple instances can represent the same documentation, it is imperative that GetHashCode (and Equals) be overridden to capture this fact. Otherwise, it is possible to end up with multiple AssemblySymbols for the same assembly, which plays havoc with the type hierarchy.
Top
See Also