ISymbol.GetDocumentationCommentXml Method

Definition

Gets the XML (as text) for the comment associated with the symbol.

public string GetDocumentationCommentXml (System.Globalization.CultureInfo preferredCulture = default, bool expandIncludes = false, System.Threading.CancellationToken cancellationToken = default);
public string? GetDocumentationCommentXml (System.Globalization.CultureInfo? preferredCulture = default, bool expandIncludes = false, System.Threading.CancellationToken cancellationToken = default);
abstract member GetDocumentationCommentXml : System.Globalization.CultureInfo * bool * System.Threading.CancellationToken -> string
Public Function GetDocumentationCommentXml (Optional preferredCulture As CultureInfo = Nothing, Optional expandIncludes As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As String

Parameters

preferredCulture
CultureInfo

Preferred culture or null for the default.

expandIncludes
Boolean

Optionally, expand <include> elements. No impact on non-source documentation comments.

cancellationToken
CancellationToken

Token allowing cancellation of request.

Returns

String

The XML that would be written to the documentation file for the symbol.

Applies to