Sha256: 1368616215675757a8637a0c208dc74366a02eee4747e44c8f7e59406ca2bfa7

Contents?: true

Size: 1.01 KB

Versions: 6

Compression:

Stored size: 1.01 KB

Contents

class YARD::Handlers::Ruby::Legacy::YieldHandler < YARD::Handlers::Ruby::Legacy::Base
  handles TkYIELD
  
  def process
    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, "", [])
    tokval_list(statement.tokens[2..-1], Token).each do |item|
      item = item.inspect unless item.is_a?(String)
      if item == "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 == "super"
        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
      end
    end

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
yard-0.5.3 lib/yard/handlers/ruby/legacy/yield_handler.rb
yard-0.5.2 lib/yard/handlers/ruby/legacy/yield_handler.rb
yard-0.5.1p1 lib/yard/handlers/ruby/legacy/yield_handler.rb
yard-0.5.1 lib/yard/handlers/ruby/legacy/yield_handler.rb
yard-0.5.0 lib/yard/handlers/ruby/legacy/yield_handler.rb
yard-0.4.0 lib/yard/handlers/ruby/legacy/yield_handler.rb