Skip to main content

​
AssemblyXmlDocumentation

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

​
Syntax

public class AssemblyXmlDocumentation

​
Inheritance

​
Constructors

​
AssemblyXmlDocumentation

public AssemblyXmlDocumentation()
Initializes a new instance of the XmlDocumentationDocument class.

​
AssemblyXmlDocumentation

public AssemblyXmlDocumentation(XDocument xmlDocument)
Initializes a new instance of the XmlDocumentationDocument class from an XML document.

​
Parameters

  • xmlDocument XDocument: The XML documentation to parse.

​
Properties

​
AssemblyName

public string AssemblyName { get; set; }
Gets or sets the name of the assembly this documentation belongs to.

​
Returns

string

​
Events

public Dictionary<string, XmlMember> Events { get; }
Gets the collection of all documented events in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Fields

public Dictionary<string, XmlMember> Fields { get; }
Gets the collection of all documented fields in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Members

public Dictionary<string, XmlMember> Members { get; set; }
Gets the collection of all documented members in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Methods

public Dictionary<string, XmlMember> Methods { get; }
Gets the collection of all documented methods in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Properties

public Dictionary<string, XmlMember> Properties { get; }
Gets the collection of all documented properties in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Types

public Dictionary<string, XmlMember> Types { get; }
Gets the collection of all documented types in the assembly.

​
Returns

Dictionary<string, XmlMember>

​
Methods

​
GetMembersByType

public Dictionary<string, XmlMember> GetMembersByType(string typeName)
Gets all members belonging to a specific type.

​
Parameters

  • typeName string: The fully qualified type name (without T: prefix).

​
Returns

Dictionary<string, XmlMember> A dictionary of members belonging to the specified type.

​
GetNamespaces

public List<string> GetNamespaces()
Gets all unique namespaces represented in the documentation.

​
Returns

List<string> A list of unique namespace names.

​
GetTypesByNamespace

public Dictionary<string, XmlMember> GetTypesByNamespace(string @namespace)
Gets all types within a specific namespace.

​
Parameters

  • namespace string: The namespace to filter by.

​
Returns

Dictionary<string, XmlMember> A dictionary of types in the specified namespace.

​
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.
⌘I