Click or drag to resize

XmlDocumentationProvider Class



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

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

The XmlDocumentationProvider type exposes the following members.

Constructors
  NameDescription
Protected methodXmlDocumentationProvider
Initializes a new instance of the XmlDocumentationProvider class
Top
Methods
  NameDescription
Public methodStatic memberCreateFromBytes
Creates an XmlDocumentationProvider from bytes representing XML documentation data.
Public methodStatic memberCreateFromFile
Creates an XmlDocumentationProvider from an XML documentation file.
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.
(Inherited from DocumentationProvider.)
Protected methodGetDocumentationForSymbol(String, CultureInfo, CancellationToken)
Fetches a documentation comment for the given member ID.
(Inherited from DocumentationProvider.)
Protected methodGetDocumentationForSymbol(String, CultureInfo, CancellationToken)
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.
(Inherited from DocumentationProvider.)
Protected methodGetSourceStream
Gets the source stream for the XML document.
Top
See Also