XmlRemarksElement

Represents a remarks XML documentation element.

Definition

Assembly: CloudNimble.EasyAF.XmlDocumentation.dll

Namespace: CloudNimble.EasyAF.XmlDocumentation

Inheritance: CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Syntax

CloudNimble.EasyAF.XmlDocumentation.XmlRemarksElement

Summary

Represents a remarks XML documentation element.

Remarks

The remarks element provides additional detailed information about a type or member. It is typically displayed after the summary and can contain more extensive explanations, usage notes, or implementation details.

Constructors

.ctor

Initializes a new instance of the XmlRemarksElement class.

Syntax

public XmlRemarksElement()

.ctor

Initializes a new instance of the XmlRemarksElement class with XML content.

Syntax

public XmlRemarksElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
element	System.Xml.Linq.XElement	The XML element to parse.

.ctor Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Initializes a new instance of the XmlDocumentationElement class.

Syntax

protected XmlDocumentationElement()

.ctor Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Initializes a new instance of the XmlDocumentationElement class with XML content.

Syntax

protected XmlDocumentationElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
element	System.Xml.Linq.XElement	The XML element to parse.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

InnerElements Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the inner XML elements for nested content.

Syntax

public System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement> InnerElements { get; set; }

Property Value

Type: System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement>

RawXml Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the raw XML content of the element.

Syntax

public string RawXml { get; set; }

Property Value

Type: string

Text Inherited

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Gets or sets the parsed text content of the element.

Syntax

public string Text { get; set; }

Property Value

Type: string

Methods

CreateDocumentationElement Inherited Virtual

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Creates the appropriate documentation element based on the XML element name.

Syntax

protected virtual CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement CreateDocumentationElement(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
element	System.Xml.Linq.XElement	The XML element to convert.

Returns

Type: CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement The appropriate documentation element, or null if not supported.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
obj	object?	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ParseInnerElements Inherited Virtual

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Parses inner XML elements recursively.

Syntax

protected virtual void ParseInnerElements(System.Xml.Linq.XElement element)

Parameters

Name	Type	Description
element	System.Xml.Linq.XElement	The parent XML element to parse.

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
objA	object?	-
objB	object?	-

Returns

Type: bool

ToMdx Override

Converts this remarks element to MDX format.

Syntax

public override string ToMdx()

Returns

Type: string The MDX representation of these remarks.

ToMdx Inherited Abstract

Inherited from CloudNimble.EasyAF.XmlDocumentation.XmlDocumentationElement

Converts this element to MDX format.

Syntax

public abstract string ToMdx()

Returns

Type: string The MDX representation of this element.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?