Class DocumentationProvider

Inheritance

object

DocumentationProvider

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Microsoft.CodeAnalysis

Assembly: Microsoft.CodeAnalysis.dll

Syntax

public abstract class DocumentationProvider

Constructors

DocumentationProvider()

Declaration

protected DocumentationProvider()

Properties

Default

Declaration

public static DocumentationProvider Default { get; }

Property Value

Type	Description
DocumentationProvider

Methods

Equals(object?)

Declaration

public override abstract bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetDocumentationForSymbol(string, CultureInfo, CancellationToken)

Declaration

protected abstract string? GetDocumentationForSymbol(string documentationMemberID, CultureInfo preferredCulture, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	documentationMemberID
CultureInfo	preferredCulture
CancellationToken	cancellationToken

Returns

Type	Description
string

GetHashCode()

Declaration

public override abstract int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()