Class: YARD::Parser::Ruby::MethodDefinitionNode

Inherits:
AstNode
  • Object
show all
Defined in:
lib/yard/parser/ruby/ast_node.rb

Constant Summary

Instance Attribute Summary (collapse)

Managing node state (collapse)

Constructor Details

This class inherits a constructor from YARD::Parser::Ruby::AstNode

Instance Attribute Details

- (Object) docstring Also known as: comments Originally defined in class AstNode

Returns the value of attribute docstring

- (Object) docstring_hash_flag Also known as: comments_hash_flag Originally defined in class AstNode

Returns the value of attribute docstring_hash_flag

- (Object) docstring_range Also known as: comments_range Originally defined in class AstNode

Returns the value of attribute docstring_range

- (String) file Originally defined in class AstNode

Returns the filename the node was parsed from

Returns:

  • (String)

    the filename the node was parsed from

- (String) full_source Originally defined in class AstNode

Returns the full source that the node was parsed from

Returns:

  • (String)

    the full source that the node was parsed from

- (Object) group Originally defined in class AstNode

Deprecated.

Groups are now defined by directives

- (Range) line_range Originally defined in class AstNode

Returns the line range in #full_source represented by the node

Returns:

  • (Range)

    the line range in #full_source represented by the node

- (AstNode?) parent Originally defined in class AstNode

Returns the node’s parent or nil if it is a root node.

Returns:

  • (AstNode, nil)

    the node’s parent or nil if it is a root node.

- (String) source Originally defined in class AstNode

Returns the parse of #full_source that the node represents

Returns:

- (Range) source_range Originally defined in class AstNode

Returns the character range in #full_source represented by the node

Returns:

  • (Range)

    the character range in #full_source represented by the node

- (Symbol) type Originally defined in class AstNode

Returns the node’s unique symbolic type

Returns:

  • (Symbol)

    the node’s unique symbolic type

Instance Method Details

- (Boolean) def?

Returns:

  • (Boolean)


429
# File 'lib/yard/parser/ruby/ast_node.rb', line 429

def def?; true end

- (Boolean) kw?

Returns:

  • (Boolean)


428
# File 'lib/yard/parser/ruby/ast_node.rb', line 428

def kw?; true end

- (Object) method_name(name_only = false)



432
433
434
435
# File 'lib/yard/parser/ruby/ast_node.rb', line 432

def method_name(name_only = false)
  name = self[index_adjust]
  name_only ? name.jump(:ident).first.to_sym : name
end

- (Object) namespace



430
# File 'lib/yard/parser/ruby/ast_node.rb', line 430

def namespace; first if index_adjust > 0 end

- (Object) parameters(include_block_param = true)



437
438
439
440
441
# File 'lib/yard/parser/ruby/ast_node.rb', line 437

def parameters(include_block_param = true)
  params = self[1 + index_adjust]
  params = params[0] if params.type == :paren
  include_block_param ? params : params[0...-1]
end