public class ConstructorTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Members
Base type:  object
Implements:  IEquatable<ConstructorTM>

Represents the template model of a constructor.

Constructors

public ConstructorTM(string Id, LanguageSpecificData<string> TypeName, ParameterTM[] Parameters, LanguageSpecificData<string[]> Modifiers, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, ExceptionTM[] Exceptions) #
Represents the template model of a constructor.
Parameters
string Id
Identifier of the constructor.
Name of the containing type.
ParameterTM[] Parameters
Collection of the constructor parameters.
Collection of the constructor modifiers (e.g. private, static, etc.)
AttributeTM[] Attributes
Array of attributes applied to the constructor.
string SummaryDocComment
summary documentation comment for the constructor. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the constructor. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the constructor. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the constructor.
ExceptionTM[] Exceptions
A collection of user-documented exceptions (using the exception XML tag) the constructor might throw.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the constructor.
public string ExampleDocComment { get; init; } #
example documentation comment for the constructor. null if the doc comment is not provided.
public ExceptionTM[] Exceptions { get; init; } #
A collection of user-documented exceptions (using the exception XML tag) the constructor might throw.
public string Id { get; init; } #
Identifier of the constructor.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of the constructor modifiers (e.g. private, static, etc.)
public ParameterTM[] Parameters { get; init; } #
Collection of the constructor parameters.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the constructor. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the constructor.
public string SummaryDocComment { get; init; } #
summary documentation comment for the constructor. null if the doc comment is not provided.
public LanguageSpecificData<string> TypeName { get; init; } #
Name of the containing type.