Class: Parser::Source::Comment

Overview

Defined Under Namespace

Classes: Associator

Class Method Summary collapse

• .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 collapse

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

5365

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

def initialize(range); end

5444

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

def associate(ast, comments); end

5455

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

def associate_by_identity(ast, comments); end

5467

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

def associate_locations(ast, comments); end

5382

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

def document?; end

5389

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

def inline?; end

5401

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

def loc; end

5407

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

def location; end

5413

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

def text; end

* Inline comments correspond to `:inline`:

    # whatever

* Block comments correspond to `:document`:

    =begin
    hi i am a document
    =end

5431

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

def type; end