Method: YARD::Templates::Helpers::MethodHelper#format_block

Defined in:
lib/yard/templates/helpers/method_helper.rb

#format_block(object) ⇒ String

Returns formatted block if one exists.

Returns:

  • (String) —

    formatted block if one exists



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 35

def format_block(object)
  if object.has_tag?(:yield) && object.tag(:yield).types
    params = object.tag(:yield).types
  elsif object.has_tag?(:yieldparam)
    params = object.tags(:yieldparam).map(&:name)
  elsif object.has_tag?(:yield)
    return "{ ... }"
  else
    params = nil
  end

  params ? h("{|" + params.join(", ") + "| ... }") : ""
end