method

include_file

Ruby latest stable (v2_5_5) - 0 notes - Class: PreProcess

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378 (0)
1_9_2_180 (0)
1_9_3_125 (34)
1_9_3_392 (0)
2_1_10 (0)
2_2_9 (0)
2_4_6
2_5_5
2_6_3
What's this?

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2_2_9) is shown here.

include_file(name, indent, encoding) public

Handles the :include: filename directive.

If the first line of the included file starts with ‘#’, and contains an encoding information in the form ‘coding:’ or ‘coding=’, it is removed.

If all lines in the included file start with a ‘#’, this leading ‘#’ is removed before inclusion. The included content is indented like the :include: directive.

Show source

# File lib/rdoc/markup/pre_process.rb, line 257
  def include_file name, indent, encoding
    full_name = find_include_file name

    unless full_name then
      warn "Couldn't find file to include '#{name}' from #{@input_file_name}"
      return ''
    end

    content = RDoc::Encoding.read_file full_name, encoding, true

    # strip magic comment
    content = content.sub(/\A# .*coding[=:].*$/, '').lstrip

    # strip leading '#'s, but only if all lines start with them
    if content =~ /^[^#]/ then
      content.gsub(/^/, indent)
    else
      content.gsub(/^#?/, indent)
    end
  end

include_file

Related methods

Method deprecated or moved

Flowdock - Team Inbox With Chat