Method: YARD::Templates::Helpers::MethodHelper#format_args

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

#format_args(object) ⇒ String

Returns formatted arguments for a method.

Returns:

  • (String) —

    formatted arguments for a method



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 7

def format_args(object)
  return if object.parameters.nil?
  params = object.parameters
  if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
    params.reject! do |param|
      param[0].to_s[0, 1] == "&" &&
        !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
    end
  end

  if params.empty?
    ""
  else
    args = params.map do |n, v|
      v ? "#{n}#{n[-1, 1] == ':' ? '' : ' ='} #{v}" : n.to_s
    end.join(", ")
    h("(#{args})")
  end
end