AssemblyModel Class

Namespace
Kampute.DocToolkit.Models
Assembly
  • Kampute.DocToolkit.dll

Definition

Represents an assembly in the documentation.
public class AssemblyModel : IEquatable<AssemblyModel>
Inheritance
Implements

Remarks

The AssemblyModel class represents the top-level organizational unit in the documentation model. Assemblies serve as containers for all types and namespaces in a .NET project, defining the deployment boundary.

This class provides properties and methods to:
  • Retrieve assembly metadata such as title, description, and version
  • Access all types exported by the assembly
  • Organize types by their namespaces
  • Create appropriate documentation model for types based on their categories
  • Find specific members by their reflection metadata

Thread Safety

All public members of the type are guaranteed to be thread-safe.

Constructors

AssemblyModel(IDocumentationContext, IAssembly)Initializes a new instance of the AssemblyModel class.

Properties

ContextGets the documentation context.
ExportedTypesGets all the types exported by the assembly.
MetadataGets the metadata of the assembly.
NameGets the name of the assembly.
NamespacesGets the namespaces exported by the assembly.

Methods

Equals(AssemblyModel)Determines whether the specified assembly is equal to the current assembly.
Equals(object)Determines whether the specified object is equal to the current object.
FindMember(IMember)Finds a member in the assembly by its reflection metadata.
GetHashCode()Returns the hash code for this instance.