Class: YARD::Handlers::Ruby::YieldHandler
Overview
Handles 'yield' calls
Constant Summary
Constant Summary
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.
Methods included from Parser::Ruby
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Attribute Details
- (Object) extra_state (readonly) Originally defined in class Base
Returns the value of attribute extra_state
- (Object) globals (readonly) Originally defined in class Base
Returns the value of attribute globals
- (Object) namespace Originally defined in class Base
Returns the value of attribute namespace
- (Object) owner Originally defined in class Base
Returns the value of attribute owner
- (Processor) parser (readonly) Originally defined in class Base
Returns the processor object that manages all global state during handling.
- (Object) scope Originally defined in class Base
Returns the value of attribute scope
- (Object) statement (readonly) Originally defined in class Base
Returns the statement object currently being processed. Usually refers to one semantic language statement, though the strict definition depends on the parser used.
- (Object) visibility Originally defined in class Base
Returns the value of attribute visibility
Instance Method Details
- (void) process
This method returns an undefined value.
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 28 29 |
# File 'lib/yard/handlers/ruby/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, "", []) if statement.type == :yield statement.jump(:list).children.each do |item| if item == s(:var_ref, s(:kw, "self")) yieldtag.types << '_self' owner.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.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.add_tag(yieldtag) unless yieldtag.types.empty? end |