public class OperatorTM

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

Constructors

public OperatorTM(string Id, LanguageSpecificData<string> Name, ParameterTM[] Parameters, TypeParameterTM[] TypeParameters, GenericTypeLinkTM ReturnType, bool ReturnsVoid, bool IsConversionOperator, LanguageSpecificData<string[]> Modifiers, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ReturnsDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, ExceptionTM[] Exceptions, CodeLinkTM InheritedFrom, CodeLinkTM BaseDeclaringType, CodeLinkTM ExplicitInterfaceType, CodeLinkTM[] ImplementedInterfaces) #
Represents the template model for a operator.
Parameters
string Id
Identifier of the operator.
LanguageSpecificData<string> Name
Name of the operator.
ParameterTM[] Parameters
Collection of the operator parameters.
TypeParameterTM[] TypeParameters
Template models of the generic type parameters declared in the operator.
GenericTypeLinkTM ReturnType
Return type of the operator.
bool ReturnsVoid
Checks whether the return type of the operator is void.
bool IsConversionOperator
Indicates whether the operator is a conversion operator.
LanguageSpecificData<string[]> Modifiers
Collection of modifiers for the operator (e.g. private, abstract, virtual, etc.)
AttributeTM[] Attributes
Array of attributes applied to the operator.
string SummaryDocComment
summary documentation comment for the operator. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the operator. null if the doc comment is not provided.
string ReturnsDocComment
Documentation comment for the operator's return value. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the operator. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the operator.
ExceptionTM[] Exceptions
A collection of user-documented exceptions (using the exception XML tag) that the operator might throw.
CodeLinkTM InheritedFrom
If the operator is inherited, this represents the type from which it originates. null if the operator is not inherited.
CodeLinkTM BaseDeclaringType
If the operator overrides another member, the base type that originally declared the operator is returned. null if the operator doesn't override anything.
CodeLinkTM ExplicitInterfaceType
If the operator is an explicit implementation, the type of the interface that explicitly declared the operator is returned. null if the operator is not an explicit implementation.
CodeLinkTM[] ImplementedInterfaces
Returns the types of the interfaces, whose part of contract this operator implements.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the operator.
public CodeLinkTM BaseDeclaringType { get; init; } #
If the operator overrides another member, the base type that originally declared the operator is returned. null if the operator doesn't override anything.
public string ExampleDocComment { get; init; } #
example documentation comment for the operator. 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 operator might throw.
public CodeLinkTM ExplicitInterfaceType { get; init; } #
If the operator is an explicit implementation, the type of the interface that explicitly declared the operator is returned. null if the operator is not an explicit implementation.
public string Id { get; init; } #
Identifier of the operator.
public CodeLinkTM[] ImplementedInterfaces { get; init; } #
Returns the types of the interfaces, whose part of contract this operator implements.
public CodeLinkTM InheritedFrom { get; init; } #
If the operator is inherited, this represents the type from which it originates. null if the operator is not inherited.
public bool IsConversionOperator { get; init; } #
Indicates whether the operator is a conversion operator.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of modifiers for the operator (e.g. private, abstract, virtual, etc.)
public LanguageSpecificData<string> Name { get; init; } #
Name of the operator.
public ParameterTM[] Parameters { get; init; } #
Collection of the operator parameters.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the operator. null if the doc comment is not provided.
public string ReturnsDocComment { get; init; } #
Documentation comment for the operator's return value. null if the doc comment is not provided.
public bool ReturnsVoid { get; init; } #
Checks whether the return type of the operator is void.
public GenericTypeLinkTM ReturnType { get; init; } #
Return type of the operator.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the operator.
public string SummaryDocComment { get; init; } #
summary documentation comment for the operator. null if the doc comment is not provided.
public TypeParameterTM[] TypeParameters { get; init; } #
Template models of the generic type parameters declared in the operator.