Class: Parser::Source::Comment

Inherits:

Object

• Object
• Parser::Source::Comment

Defined in:

sorbet/rbi/parser@3.3.7.4.rbi

Overview

A comment in the source code.

source://parser//lib/parser/source/comment.rb#17

Defined Under Namespace

Classes: Associator

Class Method Summary

• .associate(ast, comments) ⇒ Hash<Parser::AST::Node, Array<Comment>> deprecated Deprecated.

  Use Comment.associate_locations.

• .associate_by_identity(ast, comments) ⇒ Hash<Parser::Source::Node, Array<Comment>>

  Associate comments with ast nodes using identity.

• .associate_locations(ast, comments) ⇒ Hash<Parser::Source::Map, Array<Comment>>

  Associate comments with ast nodes by their location in the source.

Instance Method Summary

• #document? ⇒ Boolean

  source://parser//lib/parser/source/comment.rb#109.

• #initialize(range) ⇒ Comment constructor

  source://parser//lib/parser/source/comment.rb#67.

• #inline? ⇒ Boolean

  source://parser//lib/parser/source/comment.rb#101.

• #loc ⇒ Parser::Source::Range

  source://parser//lib/parser/source/comment.rb#20.

• #location ⇒ Parser::Source::Range

  source://parser//lib/parser/source/comment.rb#20.

• #text ⇒ String

  source://parser//lib/parser/source/comment.rb#18.

• #type ⇒ Symbol

  Type of this comment.

Constructor Details

#initialize(range) ⇒ Comment

source://parser//lib/parser/source/comment.rb#67

Parameters:

• range (Parser::Source::Range)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5359

def initialize(range); end

Class Method Details

.associate(ast, comments) ⇒ Hash<Parser::AST::Node, Array<Comment>>

Deprecated.

Use associate_locations.

Associate comments with ast nodes by their corresponding node.

source://parser//lib/parser/source/comment.rb#32

Parameters:

• ast (Parser::AST::Node)
• comments (Array<Comment>)

Returns:

• (Hash<Parser::AST::Node, Array<Comment>>)

See Also:

• Parser::Source::Comment::Associator#associate

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5438

def associate(ast, comments); end

.associate_by_identity(ast, comments) ⇒ Hash<Parser::Source::Node, Array<Comment>>

Associate comments with ast nodes using identity.

source://parser//lib/parser/source/comment.rb#59

Parameters:

• ast (Parser::AST::Node)
• comments (Array<Comment>)

Returns:

• (Hash<Parser::Source::Node, Array<Comment>>)

See Also:

• Parser::Source::Comment::Associator#associate_by_identity

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5449

def associate_by_identity(ast, comments); end

.associate_locations(ast, comments) ⇒ Hash<Parser::Source::Map, Array<Comment>>

Associate comments with ast nodes by their location in the source.

source://parser//lib/parser/source/comment.rb#46

Parameters:

• ast (Parser::AST::Node)
• comments (Array<Comment>)

Returns:

• (Hash<Parser::Source::Map, Array<Comment>>)

See Also:

• Parser::Source::Comment::Associator#associate_locations

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5461

def associate_locations(ast, comments); end

Instance Method Details

#document? ⇒ Boolean

source://parser//lib/parser/source/comment.rb#109

Returns:

• (Boolean) —

  true if this is a block comment.

See Also:

• #type

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5376

def document?; end

#inline? ⇒ Boolean

source://parser//lib/parser/source/comment.rb#101

Returns:

• (Boolean) —

  true if this is an inline comment.

See Also:

• #type

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5383

def inline?; end

#loc ⇒ Parser::Source::Range

source://parser//lib/parser/source/comment.rb#20

Returns:

• (Parser::Source::Range)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5395

def loc; end

#location ⇒ Parser::Source::Range

source://parser//lib/parser/source/comment.rb#20

Returns:

• (Parser::Source::Range)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5401

def location; end

#text ⇒ String

source://parser//lib/parser/source/comment.rb#18

Returns:

• (String)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5407

def text; end

#type ⇒ Symbol

Type of this comment.

• Inline comments correspond to :inline:

  # whatever
  

• Block comments correspond to :document:

  =begin
  hi i am a document
  =end
  

source://parser//lib/parser/source/comment.rb#89

Returns:

• (Symbol)

# File 'sorbet/rbi/parser@3.3.7.4.rbi', line 5425

def type; end