public class EnumTypeTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Types
Base type:  object
Implements:  ITemplateModelWithId, ITypeDeclarationNameTM, IEquatable<EnumTypeTM>
Represents the template model for an enum, including its members.

Constructors

public EnumTypeTM(string Id, string Name, string Namespace, string Assembly, LanguageSpecificData<string[]> Modifiers, EnumMemberTM[] Members, AttributeTM[] Attributes, CodeLinkTM DeclaringType, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments) #
Represents the template model for an enum, including its members.
Parameters
string Id
Unique identifier of the enum.
string Name
Name of the enum.
string Namespace
The namespace containing the enum.
string Assembly
The assembly containing the enum.
LanguageSpecificData<string[]> Modifiers
Collection of modifiers for the type (e.g., public, abstract).
EnumMemberTM[] Members
Template models of the enum members.
AttributeTM[] Attributes
Array of attributes applied to the enum.
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 enum. null if the doc comment is not provided.
string RemarksDocComment
'remarks' documentation comment for the enum. null if the doc comment is not provided.
string ExampleDocComment
'example' documentation comment for the enum. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the enum.

Properties

public string Assembly { get; init; } #
The assembly containing the enum.
public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the enum.
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 string ExampleDocComment { get; init; } #
'example' documentation comment for the enum. null if the doc comment is not provided.
public string Id { get; init; } #
Implements ITemplateModelWithId.Id
Unique identifier of the enum.
public EnumMemberTM[] Members { get; init; } #
Template models of the enum members.
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
Name of the enum.
public string Namespace { get; init; } #
The namespace containing the enum.
public string RemarksDocComment { get; init; } #
'remarks' documentation comment for the enum. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the enum.
public string SummaryDocComment { get; init; } #
'summary' documentation comment for the enum. null if the doc comment is not provided.