class RBS::AST::Comment

RBS allows writing documentation of declarations and members.

# This is a doc for class.
class Hello
end

Attributes

location [R] Location[bot, bot]?

string [R] String

Public Class Methods

new (string:, location:)

(string: String, location: Location[bot, bot]?) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/ast/comment.rb, line 9
def initialize(string:, location:)
  @string = string
  @location = location
end

Public Instance Methods

== (other)

(untyped other) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/ast/comment.rb, line 14
def ==(other)
  other.is_a?(Comment) && other.string == string
end

Also aliased as: eql?, eql?

eql? (other)

(untyped other) → bool

Alias for: ==

hash ()

() → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/ast/comment.rb, line 20
def hash
  self.class.hash ^ string.hash
end

to_json (state = nil)

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/ast/comment.rb, line 24
def to_json(state = nil)
  { string: string, location: location }.to_json(state)
end