XmlDocumentationProvider Class

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.7.0

Source:

XmlDocumentationProvider.cs

A class used to provide XML documentation to the compiler for members from metadata from an XML document source.

public ref class XmlDocumentationProvider abstract : Microsoft::CodeAnalysis::DocumentationProvider

public abstract class XmlDocumentationProvider : Microsoft.CodeAnalysis.DocumentationProvider

type XmlDocumentationProvider = class
    inherit DocumentationProvider

Public MustInherit Class XmlDocumentationProvider
Inherits DocumentationProvider

Inheritance

Object

DocumentationProvider

XmlDocumentationProvider

Constructors

XmlDocumentationProvider()

Methods

CreateFromBytes(Byte[])	Creates an XmlDocumentationProvider from bytes representing XML documentation data.
CreateFromFile(String)	Creates an XmlDocumentationProvider from an XML documentation file.
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. (Inherited from DocumentationProvider)
GetDocumentationForSymbol(String, CultureInfo, CancellationToken)
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. (Inherited from DocumentationProvider)
GetSourceStream(CancellationToken)	Gets the source stream for the XML document.