Class: YARD::Handlers::Ruby::Legacy::YieldHandler

Inherits:

Base

• Object
• Base
• Base
• YARD::Handlers::Ruby::Legacy::YieldHandler

show all

Defined in:

lib/yard/handlers/ruby/legacy/yield_handler.rb

Overview

Constant Summary

Constant Summary

Constants included from Parser::Ruby::Legacy::RubyToken

Parser::Ruby::Legacy::RubyToken::EXPR_ARG, Parser::Ruby::Legacy::RubyToken::EXPR_BEG, Parser::Ruby::Legacy::RubyToken::EXPR_CLASS, Parser::Ruby::Legacy::RubyToken::EXPR_DOT, Parser::Ruby::Legacy::RubyToken::EXPR_END, Parser::Ruby::Legacy::RubyToken::EXPR_FNAME, Parser::Ruby::Legacy::RubyToken::EXPR_MID, Parser::Ruby::Legacy::RubyToken::NEWLINE_TOKEN, Parser::Ruby::Legacy::RubyToken::TkReading2Token, Parser::Ruby::Legacy::RubyToken::TkSymbol2Token

Constants included from CodeObjects

CodeObjects::BUILTIN_ALL, CodeObjects::BUILTIN_CLASSES, CodeObjects::BUILTIN_EXCEPTIONS, CodeObjects::BUILTIN_EXCEPTIONS_HASH, CodeObjects::BUILTIN_MODULES, CodeObjects::CONSTANTMATCH, CodeObjects::CSEP, CodeObjects::CSEPQ, CodeObjects::ISEP, CodeObjects::ISEPQ, CodeObjects::METHODMATCH, CodeObjects::METHODNAMEMATCH, CodeObjects::NAMESPACEMATCH, CodeObjects::NSEP, CodeObjects::NSEPQ

Instance Attribute Summary (collapse)

• - (Object) extra_state inherited from Base readonly

  Returns the value of attribute extra_state.

• - (Object) globals inherited from Base readonly

  Returns the value of attribute globals.

• - (Object) namespace inherited from Base

  Returns the value of attribute namespace.

• - (Object) owner inherited from Base

  Returns the value of attribute owner.

• - (Processor) parser inherited from Base readonly

  The processor object that manages all global state during handling.

• - (Object) scope inherited from Base

  Returns the value of attribute scope.

• - (Object) statement inherited from Base readonly

  The statement object currently being processed.

• - (Object) visibility inherited from Base

  Returns the value of attribute visibility.

Instance Method Summary (collapse)

• - (void) process

  Main processing callback.

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# File 'lib/yard/handlers/ruby/legacy/yield_handler.rb', line 5

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, "", [])
  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