SyntaxFactory.XmlParamElement Method

Definition

Namespace:

Microsoft.CodeAnalysis.CSharp

Assembly:

Microsoft.CodeAnalysis.CSharp.dll

Package:

Microsoft.CodeAnalysis.CSharp v4.9.2

Overloads

XmlParamElement(String, XmlNodeSyntax[])	Creates the syntax representation of a param element within xml documentation comments (e.g. for documentation of method parameters).
XmlParamElement(String, SyntaxList<XmlNodeSyntax>)	Creates the syntax representation of a param element within xml documentation comments (e.g. for documentation of method parameters).

XmlParamElement(String, XmlNodeSyntax[])

Source:

SyntaxFactory.cs

Creates the syntax representation of a param element within xml documentation comments (e.g. for documentation of method parameters).

public:
 static Microsoft::CodeAnalysis::CSharp::Syntax::XmlElementSyntax ^ XmlParamElement(System::String ^ parameterName, ... cli::array <Microsoft::CodeAnalysis::CSharp::Syntax::XmlNodeSyntax ^> ^ content);

public static Microsoft.CodeAnalysis.CSharp.Syntax.XmlElementSyntax XmlParamElement (string parameterName, params Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax[] content);

static member XmlParamElement : string * Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax[] -> Microsoft.CodeAnalysis.CSharp.Syntax.XmlElementSyntax

Public Shared Function XmlParamElement (parameterName As String, ParamArray content As XmlNodeSyntax()) As XmlElementSyntax

Parameters

parameterName

String

The name of the parameter.

content

XmlNodeSyntax[]

A list of syntax nodes that represents the content of the param element (e.g. the description and meaning of the parameter).

Returns

XmlElementSyntax

XmlParamElement(String, SyntaxList<XmlNodeSyntax>)

Source:

SyntaxFactory.cs

Creates the syntax representation of a param element within xml documentation comments (e.g. for documentation of method parameters).

public:
 static Microsoft::CodeAnalysis::CSharp::Syntax::XmlElementSyntax ^ XmlParamElement(System::String ^ parameterName, Microsoft::CodeAnalysis::SyntaxList<Microsoft::CodeAnalysis::CSharp::Syntax::XmlNodeSyntax ^> content);

public static Microsoft.CodeAnalysis.CSharp.Syntax.XmlElementSyntax XmlParamElement (string parameterName, Microsoft.CodeAnalysis.SyntaxList<Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax> content);

static member XmlParamElement : string * Microsoft.CodeAnalysis.SyntaxList<Microsoft.CodeAnalysis.CSharp.Syntax.XmlNodeSyntax> -> Microsoft.CodeAnalysis.CSharp.Syntax.XmlElementSyntax

Public Shared Function XmlParamElement (parameterName As String, content As SyntaxList(Of XmlNodeSyntax)) As XmlElementSyntax

Parameters

parameterName

String

The name of the parameter.

content

SyntaxList<XmlNodeSyntax>

A list of syntax nodes that represents the content of the param element (e.g. the description and meaning of the parameter).

Returns

XmlElementSyntax