ISymbol.GetDocumentationCommentXml Method

  • Reference

Definition

Namespace:
Microsoft.CodeAnalysis
Assembly:
Microsoft.CodeAnalysis.dll
Package:
Microsoft.CodeAnalysis.Common v3.0.0
Package:
Microsoft.CodeAnalysis.Common v3.1.0
Package:
Microsoft.CodeAnalysis.Common v3.10.0
Package:
Microsoft.CodeAnalysis.Common v3.11.0
Package:
Microsoft.CodeAnalysis.Common v3.2.0
Package:
Microsoft.CodeAnalysis.Common v3.2.1
Package:
Microsoft.CodeAnalysis.Common v3.3.1
Package:
Microsoft.CodeAnalysis.Common v3.4.0
Package:
Microsoft.CodeAnalysis.Common v3.5.0
Package:
Microsoft.CodeAnalysis.Common v3.6.0
Package:
Microsoft.CodeAnalysis.Common v3.7.0
Package:
Microsoft.CodeAnalysis.Common v3.8.0
Package:
Microsoft.CodeAnalysis.Common v3.9.0
Package:
Microsoft.CodeAnalysis.Common v4.0.1
Package:
Microsoft.CodeAnalysis.Common v4.1.0
Package:
Microsoft.CodeAnalysis.Common v4.2.0
Package:
Microsoft.CodeAnalysis.Common v4.3.1
Package:
Microsoft.CodeAnalysis.Common v4.4.0
Package:
Microsoft.CodeAnalysis.Common v4.5.0
Package:
Microsoft.CodeAnalysis.Common v4.6.0
Package:
Microsoft.CodeAnalysis.Common v4.7.0
Package:
Microsoft.CodeAnalysis.Common v4.8.0
Package:
Microsoft.CodeAnalysis.Common v4.9.2
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs
Source:
ISymbol.cs

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