Method: YARD::Templates::Helpers::BaseHelper#link_include_file

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

#link_include_file(file) ⇒ `String`

Include a file as a docstring in output

Parameters:

file (String) —

the filename to include

Returns:

(String) —

the file’s contents

Since:

0.7.0



113
114
115

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

def link_include_file(file)
  File.read(file)
end