class Corundum::DocumentationTask

Public Class Methods

title(name) click to toggle source
# File lib/corundum/documentation-task.rb, line 18
def self.title(name)
  setting :title, name
end

Public Instance Methods

default_configuration(toolkit) click to toggle source
Calls superclass method
# File lib/corundum/documentation-task.rb, line 22
def default_configuration(toolkit)
  super
  toolkit.copy_settings_to(self)
end
define() click to toggle source
# File lib/corundum/documentation-task.rb, line 41
def define
  directory target_dir.abspath

  in_namespace do
    desc "Open up a browser to view your documentation"
    BrowserTask.define_task(self) do |t|
      t.index_html = entry_point
    end
  end
end
entry_point() click to toggle source
# File lib/corundum/documentation-task.rb, line 37
def entry_point
  entry_path.abspath
end
resolve_configuration() click to toggle source
Calls superclass method
# File lib/corundum/documentation-task.rb, line 27
def resolve_configuration
  super

  if field_unset?(:entry_link)
    self.entry_link = File::join(target_dir.relpath, entry_path.relpath)
  end

  resolve_paths
end