A project extension named "reporting" that provides basic reporting settings and utilities.
Example usage:
reporting {
baseDir "$buildDir/our-reports"
}
When implementing a task that produces reports, the location of where to generate reports should be obtained via the file(String) method of this extension.
| Modifiers | Name | Description |
|---|---|---|
static String |
DEFAULT_REPORTS_DIR_NAME |
The default name of the base directory for all reports, relative to Project.getBuildDir ({@value}). |
static String |
NAME |
The name of this extension ("{@value}") |
| Constructor and description |
|---|
ReportingExtension
(Project project) |
| Type | Name and description |
|---|---|
File |
file(String path)Creates a file object for the given path, relative to getBaseDir(). |
String |
getApiDocTitle() |
File |
getBaseDir()The base directory for all reports |
void |
setBaseDir(Object baseDir)Sets the base directory to use for all reports |
The default name of the base directory for all reports, relative to Project.getBuildDir ({@value}).
The name of this extension ("{@value}")
Creates a file object for the given path, relative to getBaseDir().
The reporting base dir can be changed, so users of this method should use it on demand where appropriate.
path - the relative pathThe base directory for all reports
This value can be changed, so any files derived from this should be calculated on demand.
Sets the base directory to use for all reports
The value will be converted to a File on demand via Project#file(Object)#file(Object).
baseDir - The base directory to use for all reports