org.gradle.api.reporting
Class ReportingExtension

java.lang.Object
  org.gradle.api.reporting.ReportingExtension

public class ReportingExtension
extends Object

Adds base configuration for reporting tasks. Example usage:

 reporting {
     baseDir "$buildDir/our-reports"
 }
 

NAME

public static final String NAME

The name of this extension (""reporting"")

See Also:

Constant Field Values

DEFAULT_REPORTS_DIR_NAME

public static final String DEFAULT_REPORTS_DIR_NAME

The default name of the base directory for all reports, relative to Project.getBuildDir() ("reports").

See Also:

Constant Field Values

ReportingExtension

public ReportingExtension(Project project)

getBaseDir

public File getBaseDir()

The base directory for all reports This value can be changed, so any files derived from this should be calculated on demand.

Returns:

The base directory for all reports

setBaseDir

public 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).

Parameters:

baseDir - The base directory to use for all reports

file

public File file(String path)

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.

Parameters:

path - the relative path

Returns:

a file object at the given path relative to getBaseDir()

getApiDocTitle

public String getApiDocTitle()