Module: YARD::Templates::Helpers::MethodHelper

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

Instance Method Summary

Instance Method Details

- (Object) format_args(object) 



4
5
6
7
8
9
10
11
12
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 4

def format_args(object)
  return if object.parameters.nil?
  unless object.parameters.empty?
    args = object.parameters.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
    h("(#{args})")
  else
    ""
  end
end

- (Object) format_block(object) 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 20

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 {|t| t.name }
  elsif object.has_tag?(:yield)
    return "{ ... }"
  else
    params = nil
  end

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

- (Object) format_code(object, show_lines = false) 



40
41
42
43
44
45
46
47
48
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 40

def format_code(object, show_lines = false)
  i = -1
  lines = object.source.split(/\n/)
  longestline = (object.line + lines.size).to_s.length
  lines.map do |line| 
    lineno = object.line + (i += 1)
    (" " * (longestline - lineno.to_s.length)) + lineno.to_s + "    " + line
  end.join("\n")
end

- (Object) format_constant(value) 



50
51
52
53
54
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 50

def format_constant(value)
  sp = value.split("\n").last[/^(\s+)/, 1]
  num = sp ? sp.size : 0
  html_syntax_highlight value.gsub(/^\s{#{num}}/, '')
end

- (Object) format_lines(object) 



34
35
36
37
38
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 34

def format_lines(object)
  return "" if object.source.nil? || object.line.nil?
  i = -1
  object.source.split(/\n/).map { object.line + (i += 1) }.join("\n")
end

- (Object) format_return_types(object) 



14
15
16
17
18
 
# File 'lib/yard/templates/helpers/method_helper.rb', line 14

def format_return_types(object)
  return unless object.has_tag?(:return) && object.tag(:return).types
  return if object.tag(:return).types.empty?
  format_types [object.tag(:return).types.first], false
end