Module Buildr::Doc
In: lib/buildr/scala/doc.rb  (CVS)
lib/buildr/groovy/doc.rb  (CVS)
lib/buildr/java/doc.rb  (CVS)
lib/buildr/core/doc.rb  (CVS)

Methods

Included Modules

Extension

Classes and Modules

Module Buildr::Doc::GroovydocDefaults
Module Buildr::Doc::JavadocDefaults
Module Buildr::Doc::ScaladocDefaults
Class Buildr::Doc::Base
Class Buildr::Doc::DocTask
Class Buildr::Doc::Groovydoc
Class Buildr::Doc::Javadoc
Class Buildr::Doc::Scaladoc
Class Buildr::Doc::VScaladoc

External Aliases

select_by_lang -> select

Public Class methods

Public Instance methods

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

By default the doc task uses all the source directories from compile.sources and generates documentation in the target/doc directory. This method accepts sources and adds them by calling Buildr::Doc::Base#from.

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

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

[Validate]