DocumentationProvider.GetDocumentationForSymbol Method

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.7.0

Source:

DocumentationProvider.cs

Fetches a documentation comment for the given member ID.

protected internal abstract string? GetDocumentationForSymbol (string documentationMemberID, System.Globalization.CultureInfo preferredCulture, System.Threading.CancellationToken cancellationToken = default);

abstract member GetDocumentationForSymbol : string * System.Globalization.CultureInfo * System.Threading.CancellationToken -> string

Protected Friend MustOverride Function GetDocumentationForSymbol (documentationMemberID As String, preferredCulture As CultureInfo, Optional cancellationToken As CancellationToken = Nothing) As String

Parameters

documentationMemberID

String

The documentation member ID of the item to fetch.

preferredCulture

CultureInfo

The preferred culture to receive a comment in. Null if there is no preference. This is a preference only, and providers may choose to provide results from another culture if the preferred culture was unavailable.

cancellationToken

CancellationToken

A cancellation token for the search.

Returns

String

A DocumentationComment.