class RBS::Annotate::Annotations::Source

Source annotation allows where the documents are copied from.

It allows specifying two directions: the source to read from, and the source to skip.

%a{annotate:rdoc:source:from=ext/pathname}
%a{annotate:rdoc:source:skip=ext/pathname/doc}

When you want to specify several paths, repeat writing the Source annotation.

Attributes

annotation [R] AST::Annotation

include_source [R] String?

skip_source [R] String?

Public Class Methods

new (annotation:, include: nil, skip: nil)

(annotation: AST::Annotation, include: String) → void
(annotation: AST::Annotation, skip: String) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/annotations.rb, line 31
def initialize(annotation:, include: nil, skip: nil)
  @annotation = annotation
  @include_source = include
  @skip_source = skip
end

Public Instance Methods

== (other)

(untyped) → bool

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/annotations.rb, line 41
def ==(other)
  other.is_a?(Source) &&
    other.annotation == annotation &&
    other.include_source == include_source &&
    other.skip_source == skip_source
end

Also aliased as: eql?, eql?

eql? (other)

(untyped) → bool

Alias for: ==

hash ()

() → Integer

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.0.3/lib/rbs/annotate/annotations.rb, line 37
def hash
  self.class.hash ^ annotation.hash ^ include_source.hash ^ skip_source.hash
end