module YARD::Handlers::Common::MethodHandler

Shared functionality between Ruby and C method handlers.

Public Instance Methods

add_predicate_return_tag(obj) click to toggle source

@param [MethodObject] obj

# File lib/yard/handlers/common/method_handler.rb, line 8
def add_predicate_return_tag(obj)
  if obj.tag(:return) && (obj.tag(:return).types || []).empty?
    obj.tag(:return).types = ['Boolean']
  elsif obj.tag(:return).nil?
    unless obj.tags(:overload).any? {|overload| overload.tag(:return) }
      obj.add_tag(YARD::Tags::Tag.new(:return, "", "Boolean"))
    end
  end
end