Class XmlDocumentationElement

Namespace

ICSharpCode.Decompiler.Documentation

Assembly

ICSharpCode.Decompiler.dll

Represents an element in the XML documentation. Any occurrences of "<inheritdoc/>" are replaced with the inherited documentation.

public class XmlDocumentationElement

Inheritance

object

XmlDocumentationElement

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

XmlDocumentationElement(string, IEntity?)

Creates a new documentation element.

public XmlDocumentationElement(string text, IEntity? declaringEntity)

Parameters

text string

declaringEntity IEntity

XmlDocumentationElement(XElement, IEntity?, Func<string, IEntity?>?)

Creates a new documentation element.

public XmlDocumentationElement(XElement element, IEntity? declaringEntity, Func<string, IEntity?>? crefResolver)

Parameters

element XElement

declaringEntity IEntity

crefResolver Func<string, IEntity>

Properties

Children

Gets the child elements.

public IList<XmlDocumentationElement> Children { get; }

Property Value

IList<XmlDocumentationElement>

DeclaringEntity

Gets the entity on which this documentation was originally declared. May return null.

public IEntity? DeclaringEntity { get; }

Property Value

IEntity

IsTextNode

Gets whether this is a pure text node.

public bool IsTextNode { get; }

Property Value

bool

Name

Gets the element name.

public string Name { get; }

Property Value

string

ReferencedEntity

Gets the entity referenced by the 'cref' attribute. May return null.

public IEntity? ReferencedEntity { get; }

Property Value

IEntity

TextContent

Gets the text content.

public string TextContent { get; }

Property Value

string

Methods

GetAttribute(string?)

Gets the attribute value.

public string? GetAttribute(string? name)

Parameters

name string

Returns

string

ToString()

public override string ToString()

Returns

string