Method: YARD::Templates::Helpers::HtmlHelper#signature

Defined in:

lib/yard/templates/helpers/html_helper.rb

#signature(meth, link = true, show_extras = true, full_attr_name = true) ⇒ String

Formats the signature of method meth.

Parameters:

• meth (CodeObjects::MethodObject) —

  the method object to list the signature of

• link (Boolean) (defaults to: true) —

  whether to link the method signature to the details view

• show_extras (Boolean) (defaults to: true) —

  whether to show extra meta-data (visibility, attribute info)

• full_attr_name (Boolean) (defaults to: true) —

  whether to show the full attribute name (“name=” instead of “name”)

Returns:

• (String) —

  the formatted method signature

# File 'lib/yard/templates/helpers/html_helper.rb', line 425

def signature(meth, link = true, show_extras = true, full_attr_name = true)
  meth = convert_method_to_overload(meth)

  type = signature_types(meth, link)
  scope = meth.scope == :class ? "+" : "-"
  name = full_attr_name ? meth.name : meth.name.to_s.gsub(/^(\w+)=$/, '\1')
  blk = format_block(meth)
  args = !full_attr_name && meth.writer? ? "" : format_args(meth)
  extras = []
  extras_text = ''
  if show_extras
    if rw = meth.attr_info
      attname = [rw[:read] ? 'read' : nil, rw[:write] ? 'write' : nil].compact
      attname = attname.size == 1 ? attname.join('') + 'only' : nil
      extras << attname if attname
    end
    extras << meth.visibility if meth.visibility != :public
    extras_text = ' <span class="extras">(' + extras.join(", ") + ')</span>' unless extras.empty?
  end
  title = "%s %s<strong>%s</strong>%s %s" % [scope, type, h(name), args, blk]
  if link
    if meth.is_a?(YARD::CodeObjects::MethodObject)
      link_title = "#{h meth.name(true)} (#{meth.scope} #{meth.type})"
    else
      link_title = "#{h name} (#{meth.type})"
    end
    obj = meth.respond_to?(:object) ? meth.object : meth
    link_url(url_for(obj), title, :title => link_title) + extras_text
  else
    title + extras_text
  end
end