public class PropertyTM

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

Constructors

public PropertyTM(string Id, string Name, GenericTypeLinkTM Type, bool HasGetter, bool HasSetter, bool IsSetterInitOnly, LanguageSpecificData<string[]> Modifiers, LanguageSpecificData<string[]> GetterModifiers, LanguageSpecificData<string[]> SetterModifiers, LanguageSpecificData<string> ConstantValue, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ValueDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, ExceptionTM[] Exceptions, CodeLinkTM InheritedFrom, CodeLinkTM BaseDeclaringType, CodeLinkTM ExplicitInterfaceType, CodeLinkTM[] ImplementedInterfaces) #
Represents the template model for a property.
Parameters
string Id
Identifier of the property.
string Name
Name of the property.
GenericTypeLinkTM Type
Type of the property.
bool HasGetter
Checks if the property has getter.
bool HasSetter
Checks if the property has setter (returns true for init only setters as well).
bool IsSetterInitOnly
Checks if the property has init only setter.
LanguageSpecificData<string[]> Modifiers
Collection of property modifiers (e.g. public, static, etc.)
LanguageSpecificData<string[]> GetterModifiers
Collection of the getter modifiers (possibly empty).
LanguageSpecificData<string[]> SetterModifiers
Collection of the setter modifiers (possibly empty).
LanguageSpecificData<string> ConstantValue
Default value of the parameter as a string.
null if the parameter has no default value.
AttributeTM[] Attributes
Array of attributes applied to the property.
string SummaryDocComment
summary documentation comment for the property. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the property. null if the doc comment is not provided.
string ValueDocComment
value documentation comment for the property. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the property. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the property.
ExceptionTM[] Exceptions
A collection of user-documented exceptions (using the exception XML tag) that the property might throw.
CodeLinkTM InheritedFrom
If the property is inherited, this represents the type from which it originates. null if the property is not inherited.
CodeLinkTM BaseDeclaringType
If the property overrides another member, this property returns the base type that originally declared the member. null if the property doesn't override anything.
CodeLinkTM ExplicitInterfaceType
If the property is an explicit implementation, the type of the interface that explicitly declared the property is returned. null if the property is not an explicit implementation.
CodeLinkTM[] ImplementedInterfaces
Returns the types of the interfaces, whose part of contract this property implements.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the property.
public CodeLinkTM BaseDeclaringType { get; init; } #
If the property overrides another member, this property returns the base type that originally declared the member. null if the property doesn't override anything.
public LanguageSpecificData<string> ConstantValue { get; init; } #
Default value of the parameter as a string.
null if the parameter has no default value.
public string ExampleDocComment { get; init; } #
example documentation comment for the property. null if the doc comment is not provided.
public ExceptionTM[] Exceptions { get; init; } #
A collection of user-documented exceptions (using the exception XML tag) that the property might throw.
public CodeLinkTM ExplicitInterfaceType { get; init; } #
If the property is an explicit implementation, the type of the interface that explicitly declared the property is returned. null if the property is not an explicit implementation.
public LanguageSpecificData<string[]> GetterModifiers { get; init; } #
Collection of the getter modifiers (possibly empty).
public bool HasGetter { get; init; } #
Checks if the property has getter.
public bool HasSetter { get; init; } #
Checks if the property has setter (returns true for init only setters as well).
public string Id { get; init; } #
Identifier of the property.
public CodeLinkTM[] ImplementedInterfaces { get; init; } #
Returns the types of the interfaces, whose part of contract this property implements.
public CodeLinkTM InheritedFrom { get; init; } #
If the property is inherited, this represents the type from which it originates. null if the property is not inherited.
public bool IsSetterInitOnly { get; init; } #
Checks if the property has init only setter.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of property modifiers (e.g. public, static, etc.)
public string Name { get; init; } #
Name of the property.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the property. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the property.
public LanguageSpecificData<string[]> SetterModifiers { get; init; } #
Collection of the setter modifiers (possibly empty).
public string SummaryDocComment { get; init; } #
summary documentation comment for the property. null if the doc comment is not provided.
public GenericTypeLinkTM Type { get; init; } #
Type of the property.
public string ValueDocComment { get; init; } #
value documentation comment for the property. null if the doc comment is not provided.