Class: YARD::Parser::Ruby::ReferenceNode

Inherits:

AstNode

• Object
• Array
• AstNode
• YARD::Parser::Ruby::ReferenceNode

Defined in:

lib/yard/parser/ruby/ast_node.rb

Constant Summary

Instance Attribute Summary

• #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

• #namespace ⇒ Object
• #path ⇒ Object
• #ref? ⇒ Boolean

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

#file ⇒ String Originally defined in class AstNode

Returns the filename the node was parsed from

Returns:

• (String) —

  the filename the node was parsed from

#full_source ⇒ String 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

#group ⇒ Object Originally defined in class AstNode

Deprecated.

Groups are now defined by directives

See Also:

• Tags::GroupDirective

#line_range ⇒ 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

#parent ⇒ AstNode^? 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.

#source ⇒ String Originally defined in class AstNode

Returns the parse of #full_source that the node represents

Returns:

• (String) —

  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

Returns:

• (Range) —

  the character range in #full_source represented by the node

#type ⇒ Symbol Originally defined in class AstNode

Returns the node's unique symbolic type

Returns:

• (Symbol) —

  the node's unique symbolic type

Instance Method Details

#namespace ⇒ Object

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

def namespace
  Array.new flatten[0...-1]
end

#path ⇒ Object

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

def path
  Array.new flatten
end

#ref? ⇒ Boolean

Returns:

• (Boolean)

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

def ref?; true end