class Rails::API::Task

Constants

RDOC_FILES

Public Class Methods

Calls superclass method
# File railties/lib/rails/api/task.rb, line 119
def initialize(name)
  super

  # Every time rake runs this task is instantiated as all the rest.
  # Be lazy computing stuff to have as light impact as possible to
  # the rest of tasks.
  before_running_rdoc do
    configure_sdoc
    configure_rdoc_files
    setup_horo_variables
  end
end

Public Instance Methods

# File railties/lib/rails/api/task.rb, line 185
def api_main
  component_root_dir("railties") + "/RDOC_MAIN.md"
end
# File railties/lib/rails/api/task.rb, line 148
def configure_rdoc_files
  rdoc_files.include(api_main)

  RDOC_FILES.each do |component, cfg|
    cdr = component_root_dir(component)

    Array(cfg[:include]).each do |pattern|
      rdoc_files.include("#{cdr}/#{pattern}")
    end

    Array(cfg[:exclude]).each do |pattern|
      rdoc_files.exclude("#{cdr}/#{pattern}")
    end
  end

  # Only generate documentation for files that have been
  # changed since the API was generated.
  if Dir.exist?(api_dir) && !ENV["ALL"]
    last_generation = DateTime.rfc2822(File.open("#{api_dir}/created.rid", &:readline))

    rdoc_files.keep_if do |file|
      File.mtime(file).to_datetime > last_generation
    end

    # Nothing to do
    exit(0) if rdoc_files.empty?
  end
end
# File railties/lib/rails/api/task.rb, line 137
def configure_sdoc
  self.title    = "Ruby on Rails API"
  self.rdoc_dir = api_dir

  options << "-m"  << api_main
  options << "-e"  << "UTF-8"

  options << "-f"  << "api"
  options << "-T"  << "rails"
end

Hack, ignore the desc calls performed by the original initializer.

# File railties/lib/rails/api/task.rb, line 133
def desc(description)
  # no-op
end