AssemblyXmlDocumentation - EasyAF

Definition

Assembly: CloudNimble.EasyAF.XmlDocumentation.dll Namespace: CloudNimble.EasyAF.XmlDocumentation Inheritance: System.Object

Syntax

CloudNimble.EasyAF.XmlDocumentation.AssemblyXmlDocumentation

Summary

Represents the root XML documentation structure for a .NET assembly.

Remarks

This class parses and contains all the XML documentation for a single assembly, including all types, members, and their associated documentation elements. It provides methods to access and filter documentation by various criteria.

Constructors

.ctor

Initializes a new instance of the XmlDocumentationDocument class.

Syntax

public AssemblyXmlDocumentation()

.ctor

Initializes a new instance of the XmlDocumentationDocument class from an XML document.

Syntax

public AssemblyXmlDocumentation(System.Xml.Linq.XDocument xmlDocument)

Parameters

Name	Type	Description
`xmlDocument`	`System.Xml.Linq.XDocument`	The XML documentation to parse.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AssemblyName

Gets or sets the name of the assembly this documentation belongs to.

Syntax

public string AssemblyName { get; set; }

Property Value

Type: string

Events

Gets the collection of all documented events in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Events { get; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Fields

Gets the collection of all documented fields in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Fields { get; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Members

Gets the collection of all documented members in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Members { get; set; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Methods

Gets the collection of all documented methods in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Methods { get; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Properties

Gets the collection of all documented properties in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Properties { get; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Types

Gets the collection of all documented types in the assembly.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> Types { get; }

Property Value

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember>

Methods

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

GetMembersByType

Gets all members belonging to a specific type.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> GetMembersByType(string typeName)

Parameters

Name	Type	Description
`typeName`	`string`	The fully qualified type name (without T: prefix).

Returns

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> A dictionary of members belonging to the specified type.

GetNamespaces

Gets all unique namespaces represented in the documentation.

Syntax

public System.Collections.Generic.List<string> GetNamespaces()

Returns

Type: System.Collections.Generic.List<string> A list of unique namespace names.

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

GetTypesByNamespace

Gets all types within a specific namespace.

Syntax

public System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> GetTypesByNamespace(string namespace)

Parameters

Name	Type	Description
`namespace`	`string`	The namespace to filter by.

Returns

Type: System.Collections.Generic.Dictionary<string, CloudNimble.EasyAF.XmlDocumentation.XmlMember> A dictionary of types in the specified namespace.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

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

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

MemberTypeEnumeration of member types in XML documentation.

⌘I