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

9 entries across 9 versions & 1 rubygems

Version	Path
yard-0.6.8	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.7	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.6	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.5	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.4	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.3	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.2	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.1	lib/yard/handlers/ruby/yield_handler.rb
yard-0.6.0	lib/yard/handlers/ruby/yield_handler.rb