SyntaxFactory.DocumentationComment(XmlNodeSyntax[]) Method

Definition

Namespace:

Microsoft.CodeAnalysis.CSharp

Assembly:

Microsoft.CodeAnalysis.CSharp.dll

Package:

Microsoft.CodeAnalysis.CSharp v4.7.0

Source:

SyntaxFactory.cs

Creates an xml documentation comment that abstracts xml syntax creation.

public:
 static Microsoft::CodeAnalysis::CSharp::Syntax::DocumentationCommentTriviaSyntax ^ DocumentationComment(... cli::array <Microsoft::CodeAnalysis::CSharp::Syntax::XmlNodeSyntax ^> ^ content);

public static Microsoft.CodeAnalysis.CSharp.Syntax.DocumentationCommentTriviaSyntax DocumentationComment (params Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax[] content);

static member DocumentationComment : Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax[] -> Microsoft.CodeAnalysis.CSharp.Syntax.DocumentationCommentTriviaSyntax

Public Shared Function DocumentationComment (ParamArray content As XmlNodeSyntax()) As DocumentationCommentTriviaSyntax

Parameters

content

XmlNodeSyntax[]

A list of xml node syntax that will be the content within the xml documentation comment (e.g. a summary element, a returns element, exception element and so on).

Returns

DocumentationCommentTriviaSyntax