|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.reporting.ReportingExtension
public class ReportingExtension
Adds base configuration for reporting tasks. Example usage:
reporting { baseDir "$buildDir/our-reports" }
Field Summary | |
---|---|
static String |
DEFAULT_REPORTS_DIR_NAME
The default name of the base directory for all reports, relative to Project.getBuildDir() ("reports"). |
static String |
NAME
The name of this extension (""reporting"") |
Constructor Summary | |
---|---|
ReportingExtension(Project project)
|
Method Summary | |
---|---|
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 This value can be changed, so any files derived from this should be calculated on demand. |
void |
setBaseDir(Object baseDir)
Sets the base directory to use for all reports The value will be converted to a File on demand via Project.file(Object) . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String NAME
public static final String DEFAULT_REPORTS_DIR_NAME
Project.getBuildDir()
("reports").
Constructor Detail |
---|
public ReportingExtension(Project project)
Method Detail |
---|
public File getBaseDir()
public void setBaseDir(Object baseDir)
File
on demand via Project.file(Object)
.
baseDir
- The base directory to use for all reportspublic File file(String path)
getBaseDir()
.
The reporting base dir can be changed, so users of this method should use it on demand where appropriate.
path
- the relative path
getBaseDir()
public String getApiDocTitle()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |