DocumentationProvider.GetDocumentationForSymbol Method
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.
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);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 -> stringProtected Friend MustOverride Function GetDocumentationForSymbol (documentationMemberID As String, preferredCulture As CultureInfo, Optional cancellationToken As CancellationToken = Nothing) As StringParameters
- 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
A DocumentationComment.
