Module: YardXML::Helper

Includes:
YARD::Templates::Helpers::HtmlHelper, YARD::Templates::Helpers::TextHelper
Defined in:
lib/yard-xml/helper.rb

Instance Method Summary collapse

Instance Method Details

#docstring_description(object, summary) ⇒ Object 



34
35
36
37
38
39
40
 
# File 'lib/yard-xml/helper.rb', line 34

def docstring_description(object, summary)
  body = object.docstring.to_s.dup
  if body.start_with?(summary)
    body[0..summary.size] = ''
  end
  html_markup_rdoc(body)
end

#docstring_summary(object) ⇒ Object 



30
31
32
 
# File 'lib/yard-xml/helper.rb', line 30

def docstring_summary(object)
  object.docstring.summary.gsub(/\n\s*/m, ' ')
end