public class ObjectTypeTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Types
Base type:  object
Implements:  ITemplateModelWithId, ITypeDeclarationNameTM, IEquatable<ObjectTypeTM>
Represents the template model for a type.

Constructors

public ObjectTypeTM(string Id, string Name, string Namespace, string Assembly, LanguageSpecificData<string[]> Modifiers, ConstructorTM[] Constructors, FieldTM[] Fields, PropertyTM[] Properties, MethodTM[] Methods, OperatorTM[] Operators, IndexerTM[] Indexers, EventTM[] Events, TypeNameTM[] NestedTypes, TypeParameterTM[] TypeParameters, GenericTypeLinkTM BaseType, GenericTypeLinkTM[] ImplementedInterfaces, AttributeTM[] Attributes, CodeLinkTM DeclaringType, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments) #
Represents the template model for a type.
Parameters
string Id
Unique identifier of the type.
string Name
The name of the type.
string Namespace
The namespace containing the type.
string Assembly
The assembly containing the type.
LanguageSpecificData<string[]> Modifiers
Collection of modifiers for the type (e.g., public, abstract).
ConstructorTM[] Constructors
Template models of the type constructors.
FieldTM[] Fields
Template models of the fields contained in the type.
PropertyTM[] Properties
Template models of the properties contained in the type.
MethodTM[] Methods
Template models of the methods contained in the type.
OperatorTM[] Operators
Template models of the operators contained in the type.
IndexerTM[] Indexers
Template models of the indexers contained in the type.
EventTM[] Events
Template models of the events contained in the type.
TypeNameTM[] NestedTypes
Template models of the nested types contained in the type.
TypeParameterTM[] TypeParameters
Template models of the generic type parameters contained in the type.
GenericTypeLinkTM BaseType
Base type of this type, null if the type doesn't have any base type.
GenericTypeLinkTM[] ImplementedInterfaces
Collection of interfaces implemented by the type.
AttributeTM[] Attributes
Array of attributes applied to the type.
CodeLinkTM DeclaringType
The type that contains the declaration of this type.
null if the type is not nested.
string SummaryDocComment
'summary' documentation comment for the type. null if the doc comment is not provided.
string RemarksDocComment
'remarks' documentation comment for the type. null if the doc comment is not provided.
string ExampleDocComment
'example' documentation comment for the type. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the type.

Properties

public string Assembly { get; init; } #
The assembly containing the type.
public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the type.
public GenericTypeLinkTM BaseType { get; init; } #
Base type of this type, null if the type doesn't have any base type.
public ConstructorTM[] Constructors { get; init; } #
Template models of the type constructors.
public CodeLinkTM DeclaringType { get; init; } #
Implements ITypeDeclarationNameTM.DeclaringType
The type that contains the declaration of this type.
null if the type is not nested.
public EventTM[] Events { get; init; } #
Template models of the events contained in the type.
public string ExampleDocComment { get; init; } #
'example' documentation comment for the type. null if the doc comment is not provided.
public FieldTM[] Fields { get; init; } #
Template models of the fields contained in the type.
public string Id { get; init; } #
Implements ITemplateModelWithId.Id
Unique identifier of the type.
public GenericTypeLinkTM[] ImplementedInterfaces { get; init; } #
Collection of interfaces implemented by the type.
public IndexerTM[] Indexers { get; init; } #
Template models of the indexers contained in the type.
public MethodTM[] Methods { get; init; } #
Template models of the methods contained in the type.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Implements ITypeDeclarationNameTM.Modifiers
Collection of modifiers for the type (e.g., public, abstract).
public string Name { get; init; } #
Implements ITypeDeclarationNameTM.Name
The name of the type.
public string Namespace { get; init; } #
The namespace containing the type.
public TypeNameTM[] NestedTypes { get; init; } #
Template models of the nested types contained in the type.
public OperatorTM[] Operators { get; init; } #
Template models of the operators contained in the type.
public PropertyTM[] Properties { get; init; } #
Template models of the properties contained in the type.
public string RemarksDocComment { get; init; } #
'remarks' documentation comment for the type. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the type.
public string SummaryDocComment { get; init; } #
'summary' documentation comment for the type. null if the doc comment is not provided.
public TypeParameterTM[] TypeParameters { get; init; } #
Implements ITypeDeclarationNameTM.TypeParameters
Template models of the generic type parameters contained in the type.