CompositeTypeModel Class

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

Definition

Represents a documentation model for a composite .NET type that can have fields and nested types.
public abstract class CompositeTypeModel : TypeModel<ICompositeType>
Inheritance
Inherited by

Remarks

The CompositeTypeModel class is an abstract base class for class and struct types that can contain fields, constructors, properties, methods, events, operators, and nested types.

Members that the compiler synthesizes, such as the equality members, ToString, Deconstruct, and copy constructor of a record, are excluded from the member collections because they have no source declaration to document. A member that overrides or replaces a synthesized member in source code is included. The metadata of the excluded members remains available through the Kampute.DocToolkit.Metadata property.

Constructors

CompositeTypeModel(object, ICompositeType)Initializes a new instance of the CompositeTypeModel class.

Properties

ConstructorsGets the constructors declared by the type and visible within its scope.
EventsGets the events declared by the type and visible within its scope.
ExplicitInterfaceMembersGets the explicit interface members implemented by the type.
FieldsGets the fields declared by the type and visible within its scope.
MembersGets all the members declared or implemented by the type.
MethodsGets the methods declared by the type and visible within its scope.
NestedTypesGets the types declared directly by this type and visible within its scope.
OperatorsGets the operators declared by the type and visible within its scope.
PropertiesGets the properties declared by the type and visible within its scope.

Methods

FindMember(IMember)Finds the documentation model representing the specified reflection member metadata within the type.