DocumentationProvider Class

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.13.0

Source:

DocumentationProvider.cs

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.

C#

public abstract class DocumentationProvider

Inheritance

Object

DocumentationProvider

Derived

Microsoft.CodeAnalysis.XmlDocumentationProvider

Constructors

DocumentationProvider()

Properties

Default

Methods

Equals(Object)	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.
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)	Fetches a documentation comment for the given member ID.
GetHashCode()	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.

Applies to