Class: Parser::Source::Comment

Inherits:
Object
  • Object
show all
Defined in:
sorbet/rbi/parser@3.3.8.0.rbi

Overview

A comment in the source code.

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

Defined Under Namespace

Classes: Associator

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(range) ⇒ Comment

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

Parameters:



5365
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5365

def initialize(range); end

Class Method Details

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

Deprecated.

Associate comments with ast nodes by their corresponding node.

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



5444
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5444

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:

Returns:

See Also:



5455
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5455

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



5467
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5467

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:



5382
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5382

def document?; end

#inline?Boolean

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

Returns:

  • (Boolean)

    true if this is an inline comment.

See Also:



5389
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5389

def inline?; end

#locParser::Source::Range

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



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

def loc; end

#locationParser::Source::Range

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



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

def location; end

#textString

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

Returns:



5413
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5413

def text; end

#typeSymbol

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:



5431
# File 'sorbet/rbi/parser@3.3.8.0.rbi', line 5431

def type; end