XmlDocumentationProvider Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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::DocumentationProviderpublic abstract class XmlDocumentationProvider : Microsoft.CodeAnalysis.DocumentationProvidertype XmlDocumentationProvider = class
inherit DocumentationProviderPublic MustInherit Class XmlDocumentationProvider
Inherits DocumentationProvider- Inheritance
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. |
