Method: YARD::Templates::Helpers::HtmlHelper#link_include_object

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

#link_include_object(obj) ⇒ `String`

Includes an object’s docstring into output.

Parameters:

object (CodeObjects::Base) —

the object to include

Returns:

(String) —

the object’s docstring (no tags)

Since:

0.6.0


238
239
240

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

def link_include_object(obj)
  htmlify(obj.docstring)
end