Class: YARD::Parser::Ruby::MethodDefinitionNode
- Defined in:
- lib/yard/parser/ruby/ast_node.rb
Constant Summary
Instance Attribute Summary collapse
-
#docstring ⇒ Object
(also: #comments)
inherited
from AstNode
Returns the value of attribute docstring.
-
#docstring_hash_flag ⇒ Object
(also: #comments_hash_flag)
inherited
from AstNode
Returns the value of attribute docstring_hash_flag.
-
#docstring_range ⇒ Object
(also: #comments_range)
inherited
from AstNode
Returns the value of attribute docstring_range.
-
#file ⇒ String
inherited
from AstNode
The filename the node was parsed from.
-
#full_source ⇒ String
inherited
from AstNode
The full source that the node was parsed from.
-
#group ⇒ Object
inherited
from AstNode
deprecated
Deprecated.
Groups are now defined by directives
-
#line_range ⇒ Range
inherited
from AstNode
The line range in AstNode#full_source represented by the node.
-
#parent ⇒ AstNode?
inherited
from AstNode
The node's parent or nil if it is a root node.
-
#source ⇒ String
inherited
from AstNode
The parse of AstNode#full_source that the node represents.
-
#source_range ⇒ Range
inherited
from AstNode
The character range in AstNode#full_source represented by the node.
-
#type ⇒ Symbol
inherited
from AstNode
The node's unique symbolic type.
Managing node state collapse
- #def? ⇒ Boolean
- #kw? ⇒ Boolean
- #method_name(name_only = false) ⇒ Object
- #namespace ⇒ Object
- #parameters(include_block_param = true) ⇒ Object
Constructor Details
This class inherits a constructor from YARD::Parser::Ruby::AstNode
Instance Attribute Details
#docstring ⇒ Object Also known as: comments Originally defined in class AstNode
Returns the value of attribute docstring
#docstring_hash_flag ⇒ Object Also known as: comments_hash_flag Originally defined in class AstNode
Returns the value of attribute docstring_hash_flag
#docstring_range ⇒ Object Also known as: comments_range Originally defined in class AstNode
Returns the value of attribute docstring_range
#full_source ⇒ String Originally defined in class AstNode
Returns the full source that the node was parsed from
#group ⇒ Object Originally defined in class AstNode
Groups are now defined by directives
#line_range ⇒ Range Originally defined in class AstNode
Returns the line range in #full_source represented by the node
#parent ⇒ AstNode? Originally defined in class AstNode
Returns the node's parent or nil if it is a root node.
#source ⇒ String Originally defined in class AstNode
Returns the parse of #full_source that the node represents
#source_range ⇒ Range Originally defined in class AstNode
Returns the character range in #full_source represented by the node
#type ⇒ Symbol Originally defined in class AstNode
Returns the node's unique symbolic type
Instance Method Details
#def? ⇒ Boolean
463 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 463 def def?; true end |
#kw? ⇒ Boolean
462 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 462 def kw?; true end |
#method_name(name_only = false) ⇒ Object
466 467 468 469 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 466 def method_name(name_only = false) name = self[index_adjust] name_only ? name.jump(:ident).first.to_sym : name end |
#namespace ⇒ Object
464 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 464 def namespace; first if index_adjust > 0 end |
#parameters(include_block_param = true) ⇒ Object
471 472 473 474 475 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 471 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 |