public class FieldTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Members
Base type:  object
Implements:  IEquatable<FieldTM>
Represents the template model for a field.

Constructors

public FieldTM(string Id, string Name, GenericTypeLinkTM Type, LanguageSpecificData<string[]> Modifiers, LanguageSpecificData<string> ConstantValue, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, CodeLinkTM InheritedFrom) #
Represents the template model for a field.
Parameters
string Id
Identifier of the field.
string Name
Name of the field.
GenericTypeLinkTM Type
Type of the field.
LanguageSpecificData<string[]> Modifiers
Collection of modifiers for the field (e.g. public, static, etc.)
LanguageSpecificData<string> ConstantValue
Default value of the field as a string.
null if the field has no default value.
AttributeTM[] Attributes
Array of attributes applied to the field.
string SummaryDocComment
summary documentation comment for the field. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the field. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the field. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the field.
CodeLinkTM InheritedFrom
If the field is inherited, this represents the type from which it originates. null if the field is not inherited.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the field.
public LanguageSpecificData<string> ConstantValue { get; init; } #
Default value of the field as a string.
null if the field has no default value.
public string ExampleDocComment { get; init; } #
example documentation comment for the field. null if the doc comment is not provided.
public string Id { get; init; } #
Identifier of the field.
public CodeLinkTM InheritedFrom { get; init; } #
If the field is inherited, this represents the type from which it originates. null if the field is not inherited.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of modifiers for the field (e.g. public, static, etc.)
public string Name { get; init; } #
Name of the field.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the field. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the field.
public string SummaryDocComment { get; init; } #
summary documentation comment for the field. null if the doc comment is not provided.
public GenericTypeLinkTM Type { get; init; } #
Type of the field.