Class: Buildr::Doc::Javadoc

Inherits:
Base show all
Defined in:
lib/buildr/java/doc.rb

Overview

A convenient task for creating Javadocs from the project’s compile task. Minimizes all the hard work to calling #from and #using.

For example:

doc.from(projects('myapp:foo', 'myapp:bar')).using(:windowtitle=>'My App')

Or, short and sweet:

desc 'My App'
define 'myapp' do
  . . .
  doc projects('myapp:foo', 'myapp:bar')
end

Instance Attribute Summary

Attributes inherited from Base

#project

Instance Method Summary collapse

Methods inherited from Base

#initialize, specify, to_sym

Constructor Details

This class inherits a constructor from Buildr::Doc::Base

Instance Method Details

#generate(sources, target, options = {}) ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/buildr/java/doc.rb', line 47

def generate(sources, target, options = {})
  options = options.dup
  options[trace?(:javadoc) ? :verbose : :quiet] = true
  options[:output] = target

  Java::Commands.javadoc(*sources.flatten.uniq, options)
end