public class MethodTM

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

Constructors

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

Properties

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