Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.gradle.api.plugins
Class ReportingBasePluginConvention

java.lang.Object
  org.gradle.api.plugins.ReportingBasePluginConvention

class ReportingBasePluginConvention

A BasePluginConvention defines the convention properties and methods used by the ReportingBasePlugin

Constructor Summary
ReportingBasePluginConvention(Project project)

 
Method Summary
java.lang.String getApiDocTitle()

Returns the title for API documentation for the project.

File getReportsDir()

Returns the directory containing all reports for this project

java.lang.String getReportsDirName()

Returns the name of the reports directory, relative to the project's build directory.

void setReportsDirName(java.lang.String reportsDirName)

Sets the name of the reports directory, relative to the project's build directory.

 
Methods inherited from class java.lang.Object
wait, wait, wait, hashCode, getClass, equals, toString, notify, notifyAll
 

Constructor Detail

ReportingBasePluginConvention

public ReportingBasePluginConvention(Project project)

 
Method Detail

getApiDocTitle

public java.lang.String getApiDocTitle()
Returns the title for API documentation for the project.
return:
The title. Never returns null.

getReportsDir

public File getReportsDir()
Returns the directory containing all reports for this project
return:
The reports directory. Never returns null.

getReportsDirName

public java.lang.String getReportsDirName()
Returns the name of the reports directory, relative to the project's build directory.
return:
The reports directory name. Never returns null.

setReportsDirName

public void setReportsDirName(java.lang.String reportsDirName)
Sets the name of the reports directory, relative to the project's build directory.
param:
reportsDirName The reports directory name. Should not be null.

 

Groovy Documentation