XmlSummaryElement

Represents a summary XML documentation element.

Syntax

public class XmlSummaryElement : XmlDocumentationElement

Inheritance

Constructors

XmlSummaryElement

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

XmlSummaryElement

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

Parameters

  • element XElement: The XML element to parse.

Methods

ToMdx

public override string ToMdx()
Converts this summary element to MDX format.

Returns

string The MDX representation of this summary.

Remarks

The summary element provides a brief description of a type or member. It is typically displayed prominently in documentation and should be concise but informative.