XmlParamRefElement

Represents a paramref XML documentation element for parameter references.

Syntax

public class XmlParamRefElement : XmlDocumentationElement

Inheritance

Constructors

XmlParamRefElement

public XmlParamRefElement()
Initializes a new instance of the XmlParamRefElement class.

XmlParamRefElement

public XmlParamRefElement(XElement element)
Initializes a new instance of the XmlParamRefElement class with XML content.

Parameters

  • element XElement: The XML element to parse.

Properties

Name

public string Name { get; set; }
Gets or sets the name of the referenced parameter.

Returns

string

Methods

ToMdx

public override string ToMdx()
Converts this paramref element to MDX format as inline code.

Returns

string The MDX representation of this parameter reference.

Remarks

The paramref element creates a reference to a parameter within the documentation. It is used to refer to parameters inline within text.