Class: Corundum::YARDoc

Inherits:
DocumentationTask show all
Defined in:
lib/corundum/documentation/yardoc.rb

Instance Method Summary collapse

Methods inherited from DocumentationTask

#entry_point, title

Instance Method Details

#default_configuration(toolkit) ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/corundum/documentation/yardoc.rb', line 29

def default_configuration(toolkit)
  super
  self.gemspec = toolkit.gemspec
  toolkit.files.copy_settings_to(self.files)
  self.files.docs = []
end

#define ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/corundum/documentation/yardoc.rb', line 55

def define
  in_namespace do
    file entry_point => document_inputs do
      YARD::CLI::Yardoc.run( *(options) )
    end

    desc "Start a live YARD server for editing inline docs"
    task :live do
      YARD::CLI::Server.run( *(options + server_options) )
    end
  end

  super
end

#document_inputs ⇒ Object 



25
26
27
 
# File 'lib/corundum/documentation/yardoc.rb', line 25

def document_inputs
  FileList["README*"] + files.code + files.docs + extra_files
end

#resolve_configuration ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/corundum/documentation/yardoc.rb', line 36

def resolve_configuration
  self.options ||= gemspec.rdoc_options
  self.options += [ "--readme", readme ] if readme
  self.options += files.code
  unless files.docs.empty? and extra_files.empty?
    self.options += [ "-" ] + files.docs  + extra_files
  end
  super
  self.options += [ "--output-dir", target_dir]


  self.server_options += ["--reload"]
  self.server_options += ["--port", server.port.to_s]
  self.server_options += ["--docroot", server.docroot]
  self.server.plugins.each do |plugin|
    self.server_options += ["--plugin", plugin]
  end
end