MethodDecl Class

Create a MethodDecl with the specified name and return type.

Create a MethodDecl with the specified name and return type.

Create a MethodDecl with the specified name and return type.

Create a MethodDecl with the specified name, return type, and modifiers.

Create a MethodDecl with the specified name and return type.

Initializes a new instance of the MethodDecl class

Create a MethodDecl with the specified name, return type, and modifiers.

This property is just to make debugging easier.

Annotations (comments, attributes, directives, messages) associated with the current code object.

The Block body.

The descriptive category of the code object.

The column number associated with the CodeObject (if any, 0 if none).

The comment for the code object (if any).

Get the declaring TypeDecl.

The documentation comment for the code object (if any).

The End-Of-Line comment for the code object (if any).

Get the explicit interface expression (if any).

True if the code object has any annotations.

True if the Statement has an argument.

True if the Statement has parens around its argument.

True if the code object has any attributes.

True if the BlockStatement has braces.

True if the BlockStatement always requires braces.

True if the code object has any comments of any kind.

True if the code object has any compiler directive annotations.

True if the code object has any documentation comments.

True if the code object has any EOL comments.

True if the code object has any EOL or Postfix annotations.

True if the code object has any error messages.

True if the code object has any annotations on separate lines.

True for all BlockStatements that have a header (all except CodeUnit and BlockDecl).

True if the code object has any Infix comments.

True if the code object has any generated messages.

Determines if the code object has no indentation.

True if the code object has any regular (non-doc) preceding (non-EOL, non-Infix, non-Postfix) comments.

True if the method has parameters.

True if the code object has any postfix annotations.

Determines if the code object has a terminator character.

True if the Statement has a terminator character by default.

Any hidden reference to another CodeObject.

The infix comment for the code object (if any).

Determines if the method is abstract.

True if the method is async.

True if the method is a COM Import.

True if the BlockStatement has compact empty braces by default.

True if the closing paren or bracket is on a new line.

True if this is an explicit interface implementation.

True if the body of the property is represented with lambda expression syntax, otherwise false.

True if the method is an extension method.

Determines if the code object appears as the first item on a line.

True if the code object defaults to starting on a new line.

Determines if the code object is generated.

True if the method is generic.

Determines if the 'grouping' (has parens or braces) status has been set.

True if this is the implementation part of a partial method.

True if the method has internal access.

True if the method is a local function (C# 7 nested method).

True if a BlockStatement is at a method body level (contains general code statements). For example, anything at a MethodDeclBase level or lower in the code tree. Specifically, NOT a NamespaceDecl, TypeDecl, or PropertyDeclBase.

True for multi-part statements, such as try/catch/finally or if/else.

Determines if the newline count has been set on the code object.

True if the method is an override.

True if the method is a partial method.

True if the method has private access.

True if the method has protected access.

True if the method has public access.

True if the method has a 'readonly' return type.

True if the method has a 'ref' return type.

True if the CodeObject is renderable.

Determines if the code object only requires a single line for display.

True if the code object only requires a single line for display by default.

True if the method is static.

True if a BlockStatement is at the top level (those that have no header and no indent). For example, a CodeUnit, a BlockDecl with no parent or a DocComment or Project parent.

True if the method is virtual.

The keyword associated with the Statement (null if none).

The line number associated with the CodeObject (if any, 0 if none).

Optional Modifiers for the method.

The name of the method.

The number of newlines preceding the object (0 to N).

The number of parameters the method has.

A collection of ParameterDecls for the parameters of the method.

The parent CodeObject.

The postfix comment for the code object (if any).

True if the BlockStatement requires an empty statement if it has an empty block with no braces.

The return type of the method (never null - will be type 'void' instead).

The terminator character for the Statement.

Accept the specified visitor object for the current code object and it's children.

Accept the specified visitor object for all regular (non-EOL, non-Infix, non-Postfix) annotations (comments, attributes, compiler directives).

Accept the specified visitor object for all specified Infix or Postfix annotations (comments, compiler directives).

Accept the specified visitor object for all EOL comments.

Accept the specified visitor object for all Infix comments.

Accept the specified visitor object for all Infix EOL comments.

Add a CodeObject to the BlockStatement body.

Add multiple CodeObjects to the BlockStatement body.

Add one or more ParameterDecls.

Add a collection of CodeObjects to the BlockStatement body.

Add the CodeObject to the specified dictionary.

Determine if the specified comment should be associated with the current code object during parsing.

Render the entire code object as a string, using LFs for newlines.

Convert the code object to text with a trailing newline, and using CR/LF pairs for newlines (file format).

Convert the code object to text using the specified flags and format (file or string).

Render all regular (non-EOL, non-Infix, non-Postfix, non-Message) annotations (comments, attributes, compiler directives).

Render all specified Infix or Postfix annotations (comments, compiler directives).

Render all EOL comments.

Render all Infix comments with the specified mask.

Render all Infix EOL comments.

Render all regular annotations on the current object, or the left most binary operator.

Determine the length of the code object if converted to a string using the specified flags.

Attach an Annotation (Comment, DocComment, Attribute, CompilerDirective, or Message) to the CodeObject.

Attach an Annotation to the CodeObject at the specified position.

Create a comment object and attach it to the code object.

Create an EOL comment object and attach it to the code object.

Create a message and attach it to the code object.

Calculate metrics for this code object and its children.

Check for alignment of any EOL comments.

Deep-clone the code object.

Clone a field of a code object, including setting the parent.

Clone a field of a code object, including setting the parent.

Check if the BlockStatement contains the specified CodeObject.

Copy formatting from another code object.

Create the list of child Annotations, or return the existing one.

Create a body if one doesn't exist yet.

Create the list of ParameterDecls, or return the existing one.

Create a reference to the MethodDecl.

Default format the code object.

Determine a default of 1 or 2 newlines when adding items to a Block.

Dispose the CodeObject.

Determines whether the specified object is equal to the current object.

Evaluate the type or namespace associated with the code object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Enumerate all children with the specified name.

Enumerate all children of type T.

Find the base virtual method for this method if it's an override.

Find the first child object of type T.

Find the first child object with the specified name and type.

Find the index of the specified CodeObject in the BlockStatement.

Find the parent object of the specified type.

Find the parent method (or anonymous method or lambda) of the current code object.

Find the parent method (or anonymous method or lambda) or type of the current code object.

Get the IsPrivate access right for the specified usage, and if not private then also get the IsProtected and IsInternal rights.

Get an enumerator for all children objects of type T in the CodeObject and in any child CodeObjects (recursively).

Returns the first attribute expression (Call or ConstructorRef) with the specified name on the CodeObject.

Get the comment that satisfies the specified predicate.

Get a short text description of the CodeObject. This is generally the shortest text representation that uniquely identifies objects, even if they have the same name, for example: type or return type, name, type parameters, parameters.

Returns the DocSummary documentation comment, or null if none exists.

Get the type of the explicit interface (null if none).

Get the full name of the INamedCodeObject, including any namespace name.

Serves as the default hash function.

Get the indent level of this object.

Get the current indent in spaces.

Determine the type of an inferred ('var') type.

Get the Namespace for this CodeObject.

Get the parameter of this method with the specified index.

Find the parameter of this method with the specified name.

Get the parameters as a descriptive string.

Gets the Type of the current instance.

Get a TypeRef for the type with the specified full name, with caching (generally used for System types).

Get the type of the worst attached message.

Returns true if the attribute with the specified name exists on the object, otherwise false.

Returns true if the code object is an UnresolvedRef or has any UnresolvedRef children.

Insert a CodeObject at the specified index in the BlockStatement body.

Returns true if the specified child object is indented from the parent.

Returns true if the specified child object is prefixed to the current object.

Determine if the specified types match the types of the method's parameters.

Creates a shallow copy of the current Object.

Move all (regular or EOL) comments from the specified token to the current code object, converting any EOL comments to regular comments (which will be rendered inline if necessary).

Move any annotations from the specified location to the specified destination location.

Move any non-EOL comments from the specified token to the current code object.

Move any non-EOL comments from the specified token to the current code object.

Move any non-EOL comments from the specified token to the current code object as Post comments.

Move any EOL or Postfix annotations from the specified code object to the current code object.

Move any EOL comment from the specified code object to the current code object.

Move any EOL comment from the specified token to the current code object.

Move any EOL comment from the specified token to the current code object.

Move any EOL comment from the specified token to the current code object as an Infix EOL comment.

Move formatting from the specified code object to the current object.

Move formatting from the specified token to the current object.

Move any prefix annotations on the specified code object to the current code object as the specified type of annotation.

Propagate the listed annotation to the parent CodeUnit and above.

Remove the listed annotation from the parent CodeUnit and above.

Parse a MethodDecl.

Parse annotations - specifically, compiler directives around things such as TypeParameters or ParameterDecls.

Parse any comments, attributes, compiler directives.

Parse the specified expected token, attaching a parse error to the current object if it doesn't exist.

Parse the terminator at the end of a Statement.

Parse annotations from the Unused list.

This method is used when we must parse backwards through the Unused list to get a type.

Reformat the Block body.

Remove the specified CodeObject from the BlockStatement body.

Remove all CodeObjects from the BlockStatement body.

Remove all annotations of the specified type from this object.

Remove all annotations from this object where the specified predicate is true.

Remove all messages from this object, or optionally only from the specified source.

Remove the CodeObject at the specified index from the BlockStatement.

Remove the attribute expression with the specified name.

Remove the CodeObject from the specified dictionary.

Replace the specified CodeObject with a new one.

Resolve all child symbolic references.

Resolve all child symbolic references, using the specified ResolveCategory and ResolveFlags.

Resolve any attached attributes.

Resolve any references in attached documentation comments.

Resolve child code objects that match the specified name are valid goto targets, moving up the tree until a complete match is found.

Resolve indexers.

Resolve child code objects that match the specified name.

Resolve child code objects that match the specified name, moving up the tree until a complete match is found.

Similar to ResolveRefUp(String, Resolver), but skips trying to resolve the symbol in the body or parameters of a method (used for resolving parameter types).

Set a field of a code object, including setting the parent, and optional formatting.

Set a ChildList collection field of a code object, including setting the parent.

Set a field of a code object, including setting the parent, and optional formatting.

Set the line and column numbers to those in the specified CodeObject.

Set the line and column numbers to those in the specified token.

Special method to set the newline count without setting the NewLinesSet flag.

Set the starting line and column numbers to those in the specified token (used by some code objects with prefixes such as modifiers).

Determines if the body of the BlockStatement should be formatted with braces.

Render the type of the code object and its description as a string.

Recursively update the dictionary of names in the specified Block by either adding or removing (as specified by the 2nd parameter) all appropriate nested INamedCodeObjects expressions in the current CodeObject tree (specifically implemented for LocalDeclExpr expression objects).

Update the line and column numbers according to the current positions in the CodeWriter, if the UpdateLineCol flag is set.

Any Annotations (Comments, DocComments, Attributes, or Messages) associated with the CodeObject (null if none).

The body is always a Block, which in turn may contain zero or more other code objects, and it can also be null in special cases (such as for method signatures with no body, delegate declarations, or a While with the semi-colon on the same line).

The starting column number associated with the CodeObject if parsed from or written to text form.

Formatting flags - for line feeds, braces, etc.

The starting line number associated with the CodeObject if parsed from or written to text form.

The name can be a string or an Expression (in which case it should be a Dot operator with a TypeRef to an Interface on the left and an interface member ref on the right). For ConstructorDecls and DestructorDecls, the name should be null (they take on the name of their parent type).

The parent CodeObject.

The return type is an Expression that must evaluate to a TypeRef in valid code.