Class | Buildr::Doc::DocTask |
In: |
lib/buildr/core/doc.rb
(CVS)
|
Parent: | Rake::Task |
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. |
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')
Includes additional source files and directories when generating the documentation and returns self. When specifying a directory, includes all source files in that directory.
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
Sets the documentation tool options from a hash and returns self.
For example:
doc.using :windowtitle=>'My application' doc.using :vscaladoc