+ class Buildr::Doc::DocTask +

+ +

+ + + + +

+ + + + + + + +

Attributes

+ + +

+ classpath[RW] +

+ +

Classpath dependencies.

+ +

+ options[R] +

+ +

Returns the documentation tool options.

+ +

+ sourcepath[RW] +

+ +

Additional sourcepaths that are not part of the documented files.

+ +

+ target[R] +

+ +

The target directory for the generated documentation files.

+ +

+ + + +

Public Instance Methods

+ + +

+ +

+ engine() + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/core/doc.rb, line 162
+def engine
+  @engine ||= guess_engine
+end

+ +

+ + + + +

+ + +

+ + engine?(clazz) → boolean + + + click to toggle source + +

+ + + +

+ +

Check if the underlying engine is an instance of the given class

+ + + + +

# File lib/buildr/core/doc.rb, line 170
+def engine?(clazz)
+  begin
+    @engine ||= guess_engine if project.compile.language
+  rescue
+    return false
+  end
+  @engine.is_a?(clazz) if @engine
+end

+ +

+ + + + +

+ + +

+ + exclude(*files) → self + + + click to toggle source + +

+ + + +

+ +

Excludes source files and directories from generating the documentation.

+ + + + +

# File lib/buildr/core/doc.rb, line 129
+def exclude(*files)
+  @files.exclude *files.collect{|f|File.expand_path(f)}
+  self
+end

+ +

+ + + + +

+ + +

+ + from(*sources) → self + + + click to toggle source + +

+ + + +

+ +

Includes files, directories and projects in the documentation and returns +self.

+ +

You can call this method with source files and directories containing +source files to include these files in the documentation, similar to include. You can also call this +method with projects. When called with a project, it includes all the +source files compiled by that project and classpath dependencies used when +compiling.

+ +

For example:

+ +

doc.from projects('myapp:foo', 'myapp:bar')
+

+ + + + +

# File lib/buildr/core/doc.rb, line 191
+def from(*sources)
+  sources.flatten.each do |source|
+    case source
+    when Project
+      self.enhance source.prerequisites
+      self.include source.compile.sources
+      self.with source.compile.dependencies
+    when Rake::Task, String
+      self.include source
+    else
+      fail "Don't know how to generate documentation from #{source || 'nil'}"
+    end
+  end
+  self
+end

+ +

+ + + + +

+ + +

+ + include(*files) → self + + + click to toggle source + +

+ + + +

+ +

Includes additional source files and directories when generating the +documentation and returns self. When specifying a directory, includes all +source files in that directory.

+ + + + +

# File lib/buildr/core/doc.rb, line 114
+def include(*files)
+  files.each do |file|
+    if file.respond_to? :to_ary
+      include(*file.to_ary)
+    else
+      @files.include *files.flatten.compact.collect { |f| File.expand_path(f.to_s) }
+    end
+  end
+  self
+end

+ +

+ + + + +

+ + +

+ + into(path) → self + + + click to toggle source + +

+ + + +

+ +

Sets the target directory and returns self. This will also set the Javadoc task as a prerequisite to a file task on +the target directory.

+ +

For example:

+ +

package :zip, :classifier=>'docs', :include=>doc.target
+

+ + + + +

# File lib/buildr/core/doc.rb, line 104
+def into(path)
+  @target = file(path.to_s).enhance([self]) unless @target && @target.to_s == path.to_s
+  self
+end

+ +

+ + + + +

+ + +

+ + using(options) → self + + + click to toggle source + +

+ + + +

+ +

Sets the documentation tool options from a hash and returns self.

+ +

For example:

+ +

doc.using :windowtitle=>'My application'
+doc.using :vscaladoc
+

+ + + + +

# File lib/buildr/core/doc.rb, line 151
+def using(*args)
+  args.pop.each { |key, value| @options[key.to_sym] = value } if Hash === args.last
+
+  until args.empty?
+    new_engine = Doc.select_by_name(args.pop)
+    @engine = new_engine.new(project) unless new_engine.nil?
+  end
+
+  self
+end

+ +

+ + + + +

+ + +

+ + with(*artifacts) → self + + + click to toggle source + +

+ + + +

+ +

Adds files and artifacts as classpath dependencies, and returns self.

+ + + + +

# File lib/buildr/core/doc.rb, line 138
+def with(*specs)
+  @classpath |= Buildr.artifacts(specs.flatten).uniq
+  self
+end

+ +

+ + + + +

+ + +

+ +

+ class Buildr::Doc::Groovydoc +

+ +

+ + + + +

+ + + + + + + + + +

Public Instance Methods

+ + +

+ +

+ generate(sources, target, options = {}) + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/groovy/doc.rb, line 34
+def generate(sources, target, options = {})
+  mkdir_p target
+  cmd_args = [ '-d', target, trace?(:groovydoc) ? '-verbose' : nil ].compact
+  options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
+    each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+    each do |key, value|
+      case value
+      when true, nil
+        cmd_args << "-#{key}"
+      when false
+        cmd_args << "-no#{key}"
+      when Hash
+        value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+      else
+        cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+      end
+    end
+  [:sourcepath, :classpath].each do |option|
+    Array(options[option]).flatten.tap do |paths|
+      cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+    end
+  end
+  cmd_args += sources.flatten.uniq
+  unless Buildr.application.options.dryrun
+    info "Generating Groovydoc for #{project.name}"
+    trace (['groovydoc'] + cmd_args).join(' ')
+    result = Java::Commands.java('org.codehaus.groovy.tools.groovydoc.Main', cmd_args,
+                                  :classpath => Buildr::Groovy.dependencies)
+  end
+end

+ +

+ + + + +

+ + +

+ +

+ class Buildr::Doc::Javadoc +

+ +

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

+ +

+ + + + +

+ + + + + + + + + +

Public Instance Methods

+ + +

+ +

+ generate(sources, target, options = {}) + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/java/doc.rb, line 46
+def generate(sources, target, options = {})
+  cmd_args = [ '-d', target, trace?(:javadoc) ? '-verbose' : '-quiet' ]
+  options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
+    each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+    each do |key, value|
+      case value
+      when true, nil
+        cmd_args << "-#{key}"
+      when false
+        cmd_args << "-no#{key}"
+      when Hash
+        value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+      else
+        cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+      end
+    end
+  [:sourcepath, :classpath].each do |option|
+    Array(options[option]).flatten.tap do |paths|
+      cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+    end
+  end
+  cmd_args += sources.flatten.uniq
+  unless Buildr.application.options.dryrun
+    info "Generating Javadoc for #{project.name}"
+    trace (['javadoc'] + cmd_args).join(' ')
+    Java.load
+    Java.com.sun.tools.javadoc.Main.execute(cmd_args.to_java(Java.java.lang.String)) == 0 or
+      fail 'Failed to generate Javadocs, see errors above'
+  end
+end

+ +

+ + + + +

+ + +

+ +

+ module Buildr::Doc::JavadocDefaults +

+ +

+ + + + +

+ + + + + + + + + +

+ class Buildr::Doc::Scaladoc +

+ +

+ + + + +

+ + + + + + + + + +

Public Instance Methods

+ + +

+ +

+ generate(sources, target, options = {}) + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/scala/doc.rb, line 40
+def generate(sources, target, options = {})
+  cmd_args = [ '-d', target]
+  cmd_args << '-verbose' if trace?(:scaladoc)
+  options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
+    each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+    each do |key, value|
+      case value
+      when true, nil
+        cmd_args << "-#{key}"
+      when false
+        cmd_args << "-no#{key}"
+      when Hash
+        value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+      else
+        cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+      end
+    end
+  [:sourcepath, :classpath].each do |option|
+    Array(options[option]).flatten.tap do |paths|
+      cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+    end
+  end
+  cmd_args += sources.flatten.uniq
+  unless Buildr.application.options.dryrun
+    info "Generating Scaladoc for #{project.name}"
+    trace (['scaladoc'] + cmd_args).join(' ')
+    Java.load
+    begin
+      if Scala.version?(2.7, 2.8)
+        Java.scala.tools.nsc.ScalaDoc.process(cmd_args.to_java(Java.java.lang.String))
+      else
+        scaladoc = Java.scala.tools.nsc.ScalaDoc.new
+        scaladoc.process(cmd_args.to_java(Java.java.lang.String))
+      end
+    rescue => e
+      fail 'Failed to generate Scaladocs, see errors above: ' + e
+    end
+  end
+end

+ +

+ + + + +

+ + +

+ +

+ module Buildr::Doc::ScaladocDefaults +

+ +

+ + + + +

+ + + + + + + + + +

+ class Buildr::Doc::VScaladoc +

+ +

+ + + + +

+ + + + + +

Constants

VERSION + +: + + +

+ + + + + +

Public Class Methods

+ + +

+ +

+ dependencies() + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/scala/doc.rb, line 85
+def dependencies
+  case
+    when Buildr::Scala.version?("2.7")
+      [ "org.scala-tools:vscaladoc:jar:#{VERSION}" ]
+    else
+      warn "VScalaDoc not supported for Scala 2.8+"
+      []
+  end
+end

+ +

+ + + + +

+ + +

+ +

Public Instance Methods

+ + +

+ +

+ generate(sources, target, options = {}) + + click to toggle source + +

+ + +

+ + + + + + +

# File lib/buildr/scala/doc.rb, line 100
+def generate(sources, target, options = {})
+  cmd_args = [ '-d', target, (trace?(:vscaladoc) ? '-verbose' : ''),
+    '-sourcepath', project.compile.sources.join(File::PATH_SEPARATOR) ]
+  options.reject { |key, value| [:sourcepath, :classpath].include?(key) }.
+    each { |key, value| value.invoke if value.respond_to?(:invoke) }.
+    each do |key, value|
+      case value
+      when true, nil
+        cmd_args << "-#{key}"
+      when false
+        cmd_args << "-no#{key}"
+      when Hash
+        value.each { |k,v| cmd_args << "-#{key}" << k.to_s << v.to_s }
+      else
+        cmd_args += Array(value).map { |item| ["-#{key}", item.to_s] }.flatten
+      end
+    end
+  [:sourcepath, :classpath].each do |option|
+    Array(options[option]).flatten.tap do |paths|
+      cmd_args << "-#{option}" << paths.flatten.map(&:to_s).join(File::PATH_SEPARATOR) unless paths.empty?
+    end
+  end
+  cmd_args += sources.flatten.uniq
+  unless Buildr.application.options.dryrun
+    info "Generating VScaladoc for #{project.name}"
+    trace (['vscaladoc'] + cmd_args).join(' ')
+    Java.load
+    Java.org.scala_tools.vscaladoc.Main.main(cmd_args.to_java(Java.java.lang.String)) == 0 or
+      fail 'Failed to generate VScaladocs, see errors above'
+  end
+end

+ +

+ + + + +

+ + +

+ +

+ module Buildr::Eclipse +

+ +

+ + + + +

+ + + + + + + + + +

+ module Buildr::Eclipse::Builder +

+ +

+ + + + +

+ + + + + + + + + +