XmlMember

Represents a documented member from XML documentation.

Syntax

public class XmlMember

Inheritance

Constructors

XmlMember

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

XmlMember

public XmlMember(XElement memberElement)
Initializes a new instance of the XmlMember class from an XML element.

Parameters

  • memberElement XElement: The XML member element to parse.

Properties

Examples

public List<XmlExampleElement> Examples { get; set; }
Gets the collection of example documentation elements.

Returns

List<XmlExampleElement>

Exceptions

public List<XmlExceptionElement> Exceptions { get; set; }
Gets the collection of exception documentation elements.

Returns

List<XmlExceptionElement>

MemberType

public MemberType MemberType { get; set; }
Gets or sets the member type (Type, Method, Property, Field, Event).

Returns

MemberType

Name

public string Name { get; set; }
Gets or sets the full member name with prefix (e.g., T:System.String, M:System.String.Length).

Returns

string

Parameters

public List<XmlParameterElement> Parameters { get; set; }
Gets the collection of parameter documentation elements.

Returns

List<XmlParameterElement>

Permissions

public List<XmlPermissionElement> Permissions { get; set; }
Gets the collection of permission documentation elements.

Returns

List<XmlPermissionElement>

Remarks

public XmlRemarksElement Remarks { get; set; }
Gets or sets the remarks documentation element.

Returns

XmlRemarksElement

Returns

public XmlReturnsElement Returns { get; set; }
Gets or sets the returns documentation element.

Returns

XmlReturnsElement

SeeAlso

public List<XmlSeeAlsoElement> SeeAlso { get; set; }
Gets the collection of see also references.

Returns

List<XmlSeeAlsoElement>

Summary

public XmlSummaryElement Summary { get; set; }
Gets or sets the summary documentation element.

Returns

XmlSummaryElement

TypeParameters

public List<XmlTypeParameterElement> TypeParameters { get; set; }
Gets the collection of type parameter documentation elements.

Returns

List<XmlTypeParameterElement>

Value

public XmlValueElement Value { get; set; }
Gets or sets the value documentation element (for properties).

Returns

XmlValueElement

Methods

GetContainingType

public string GetContainingType()
Gets the containing type name for members.

Returns

string The containing type name, or empty string for types.

GetNamespace

public string GetNamespace()
Gets the namespace of the member.

Returns

string The namespace name.

GetSimpleName

public string GetSimpleName()
Gets the simple name of the member without prefix and namespace.

Returns

string The simple member name.

Remarks

This class contains all the documentation elements for a single member, including summary, remarks, parameters, return values, exceptions, and examples. It provides methods to convert the documentation to various formats.