Class: YARD::Parser::Ruby::ParameterNode
Constant Summary
Instance Attribute Summary (collapse)
-
- (Object) docstring
(also: #comments)
inherited
from AstNode
Returns the value of attribute docstring.
-
- (Object) docstring_hash_flag
(also: #comments_hash_flag)
inherited
from AstNode
Returns the value of attribute docstring_hash_flag.
-
- (Object) docstring_range
(also: #comments_range)
inherited
from AstNode
Returns the value of attribute docstring_range.
-
- (String) file
inherited
from AstNode
The filename the node was parsed from.
-
- (String) full_source
inherited
from AstNode
The full source that the node was parsed from.
-
- (Object) group
inherited
from AstNode
deprecated
Deprecated.
Groups are now defined by directives
-
- (Range) line_range
inherited
from AstNode
The line range in AstNode#full_source represented by the node.
-
- (AstNode?) parent
inherited
from AstNode
The node's parent or nil if it is a root node.
-
- (String) source
inherited
from AstNode
The parse of AstNode#full_source that the node represents.
-
- (Range) source_range
inherited
from AstNode
The character range in AstNode#full_source represented by the node.
-
- (Symbol) type
inherited
from AstNode
The node's unique symbolic type.
Managing node state (collapse)
- - (Object) block_param
- - (Object) double_splat_param
- - (Object) named_params
- - (Object) splat_param
- - (Object) unnamed_end_params
- - (Object) unnamed_optional_params
- - (Object) unnamed_required_params
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) full_source Originally defined in class AstNode
Returns the full source that the node was parsed from
- (Object) group Originally defined in class AstNode
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
- (AstNode?) parent Originally defined in class AstNode
Returns 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
- (Range) source_range Originally defined in class AstNode
Returns the character range in #full_source represented by the node
- (Symbol) type Originally defined in class AstNode
Returns the node's unique symbolic type
Instance Method Details
- (Object) block_param
416 417 418 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 416 def block_param self[-1] ? self[-1][0] : nil end |
- (Object) double_splat_param
412 413 414 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 412 def double_splat_param YARD.ruby2? ? self[-2] : nil end |
- (Object) named_params
394 395 396 397 398 399 400 401 402 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 394 def named_params return @named_params if defined?(@named_params) if YARD.ruby2? && self[-3] && self[-3][0] && self[-3][0].type == :named_arg @named_params = self[-3] else @named_params = nil end end |
- (Object) splat_param
404 405 406 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 404 def splat_param self[2] ? self[2][0] : nil end |
- (Object) unnamed_end_params
408 409 410 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 408 def unnamed_end_params self[3] end |
- (Object) unnamed_optional_params
383 384 385 386 387 388 389 390 391 392 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 383 def unnamed_optional_params return @unnamed_optional_params if defined?(@unnamed_optional_params) params = self[1] || [] if self[-3] && self[-3][0] && self[-3][0].type == :unnamed_optional_arg params += self[-3] end @unnamed_optional_params = params.empty? ? nil : params end |
- (Object) unnamed_required_params
379 380 381 |
# File 'lib/yard/parser/ruby/ast_node.rb', line 379 def unnamed_required_params self[0] end |