Class: Tapioca::Gem::Listeners::YardDoc

Inherits:

Base

• Object
• Base
• Tapioca::Gem::Listeners::YardDoc

Extended by:

T::Sig

Defined in:

lib/tapioca/gem/listeners/yard_doc.rb

Constant Summary

IGNORED_COMMENTS =

T.let(
  [
    ":doc:",
    ":nodoc:",
    "typed:",
    "frozen_string_literal:",
    "encoding:",
    "warn_indent:",
    "shareable_constant_value:",
    "rubocop:",
  ],
  T::Array[String],
)

IGNORED_SIG_TAGS =

T.let(["param", "return"], T::Array[String])

Instance Method Summary

• #initialize(pipeline) ⇒ YardDoc constructor

  A new instance of YardDoc.

Methods inherited from Base

#dispatch

Constructor Details

#initialize(pipeline) ⇒ YardDoc

Returns a new instance of YardDoc.

# File 'lib/tapioca/gem/listeners/yard_doc.rb', line 27

def initialize(pipeline)
  YARD::Registry.clear
  super(pipeline)
  pipeline.gem.parse_yard_docs
end