Sha256: f7d2f34720ab41802ee4a3e6f1c19bc248d7c144e2516947efa281d8fdb3e8eb

Contents?: true

Size: 1.05 KB

Versions: 60

Compression:

Stored size: 1.05 KB

Contents

# Handles 'yield' calls
class YARD::Handlers::Ruby::YieldHandler < YARD::Handlers::Ruby::Base
  handles :yield, :yield0

  process do
    return unless owner.is_a?(MethodObject) # Only methods yield
    return if owner.has_tag? :yield         # Don't override yield tags
    return if owner.has_tag? :yieldparam    # Same thing.

    yieldtag = YARD::Tags::Tag.new(:yield, "", [])

    if statement.type == :yield
      statement.jump(:list).children.each do |item|
        if item == s(:var_ref, s(:kw, "self"))
          yieldtag.types << '_self'
          owner.docstring.add_tag YARD::Tags::Tag.new(:yieldparam,
            "the object that the method was called on", owner.namespace.path, '_self')
        elsif item == s(:zsuper)
          yieldtag.types << '_super'
          owner.docstring.add_tag YARD::Tags::Tag.new(:yieldparam,
            "the result of the method from the superclass", nil, '_super')
        else
          yieldtag.types << item.source
        end
      end
    end

    owner.docstring.add_tag(yieldtag) unless yieldtag.types.empty?
  end
end

Version data entries

60 entries across 48 versions & 5 rubygems

Version Path
challah-1.0.0.beta vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-0.9.1.beta.3 vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-0.9.1.beta vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-0.9.0 vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.3/vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.2.0 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.0.pre/vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.2.0 vendor/bundle/gems/challah-0.8.3/vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.2.0 vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-0.8.3 vendor/bundle/gems/yard-0.8.3/lib/yard/handlers/ruby/yield_handler.rb
challah-0.8.3 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
yard-0.8.3 lib/yard/handlers/ruby/yield_handler.rb
challah-0.8.1 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.1.0 vendor/bundle/gems/challah-0.8.0.pre/vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-rolls-0.1.0 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-0.8.0.pre vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-0.7.1 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-0.7.0 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-0.7.0.pre2 vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb
challah-0.7.0.pre vendor/bundle/gems/yard-0.8.2.1/lib/yard/handlers/ruby/yield_handler.rb