Module: Buildr::Javadoc

Includes:
Extension
Included in:
Project
Defined in:
lib/buildr/java/compiler.rb

Overview

Methods added to Project for creating JavaDoc documentation.

Defined Under Namespace

Classes: JavadocTask

Instance Method Summary collapse

Methods included from Extension

included

Instance Method Details

#javadoc(*sources, &block) ⇒ Object

:call-seq:

javadoc(*sources) => JavadocTask

This method returns the project’s Javadoc task. It also accepts a list of source files, directories and projects to include when generating the Javadocs.

By default the Javadoc task uses all the source directories from compile.sources and generates Javadocs in the target/javadoc directory. This method accepts sources and adds them by calling JavadocsTask#from.

For example, if you want to generate Javadocs for a given project that includes all source files in two of its sub-projects:

javadoc projects('myapp:foo', 'myapp:bar').using(:windowtitle=>'Docs for foo and bar')



303
304
305
 
# File 'lib/buildr/java/compiler.rb', line 303

def javadoc(*sources, &block)
  task('javadoc').from(*sources).enhance &block
end