Method: YARD::Templates::Helpers::BaseHelper#link_include_object

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

#link_include_object(obj) ⇒ `String`

Includes an object’s docstring into output.

Parameters:

obj (CodeObjects::Base) —

the object to include

Returns:

(String) —

the object’s docstring (no tags)

Since:

0.6.0



105
106
107

# File 'lib/yard/templates/helpers/base_helper.rb', line 105

def link_include_object(obj)
  obj.docstring
end