Definition
Assembly: CloudNimble.EasyAF.XmlDocumentation.dll Namespace: CloudNimble.EasyAF.XmlDocumentation Inheritance: System.ObjectSyntax
Summary
Represents a documented member from XML documentation.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.Constructors
.ctor
Initializes a new instance of the XmlMember class.Syntax
.ctor
Initializes a new instance of the XmlMember class from an XML element.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
memberElement | System.Xml.Linq.XElement | The XML member element to parse. |
.ctor Inherited
Inherited from
objectSyntax
Properties
Examples
Gets the collection of example documentation elements.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlExampleElement>
Exceptions
Gets the collection of exception documentation elements.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlExceptionElement>
MemberType
Gets or sets the member type (Type, Method, Property, Field, Event).Syntax
Property Value
Type:CloudNimble.EasyAF.XmlDocumentation.MemberType
Name
Gets or sets the full member name with prefix (e.g., T:System.String, M:System.String.Length).Syntax
Property Value
Type:string
Parameters
Gets the collection of parameter documentation elements.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlParameterElement>
Permissions
Gets the collection of permission documentation elements.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlPermissionElement>
Remarks
Gets or sets the remarks documentation element.Syntax
Property Value
Type:CloudNimble.EasyAF.XmlDocumentation.XmlRemarksElement
Returns
Gets or sets the returns documentation element.Syntax
Property Value
Type:CloudNimble.EasyAF.XmlDocumentation.XmlReturnsElement
SeeAlso
Gets the collection of see also references.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlSeeAlsoElement>
Summary
Gets or sets the summary documentation element.Syntax
Property Value
Type:CloudNimble.EasyAF.XmlDocumentation.XmlSummaryElement
TypeParameters
Gets the collection of type parameter documentation elements.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.EasyAF.XmlDocumentation.XmlTypeParameterElement>
Value
Gets or sets the value documentation element (for properties).Syntax
Property Value
Type:CloudNimble.EasyAF.XmlDocumentation.XmlValueElement
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetContainingType
Gets the containing type name for members.Syntax
Returns
Type:string
The containing type name, or empty string for types.
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetNamespace
Gets the namespace of the member.Syntax
Returns
Type:string
The namespace name.
GetSimpleName
Gets the simple name of the member without prefix and namespace.Syntax
Returns
Type:string
The simple member name.
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?