public class EnumMemberTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Members
Base type:  object
Implements:  IEquatable<EnumMemberTM>
Represents the template model for an enum member.

Constructors

public EnumMemberTM(string Id, string Name, LanguageSpecificData<string> Value, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments) #
Represents the template model for an enum member.
Parameters
string Id
Identifier of the enum member.
string Name
Name of the enum member.
LanguageSpecificData<string> Value
String representation of the underlying integral value of the enum member.
AttributeTM[] Attributes
Array of attributes applied to the member.
string SummaryDocComment
summary documentation comment for the enum member. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the enum member. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the enum member. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the enum member.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the member.
public string ExampleDocComment { get; init; } #
example documentation comment for the enum member. null if the doc comment is not provided.
public string Id { get; init; } #
Identifier of the enum member.
public string Name { get; init; } #
Name of the enum member.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the enum member. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the enum member.
public string SummaryDocComment { get; init; } #
summary documentation comment for the enum member. null if the doc comment is not provided.
public LanguageSpecificData<string> Value { get; init; } #
String representation of the underlying integral value of the enum member.