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

## org.gradle.api.plugins
[Java] Class ReportingBasePluginConvention

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

    public class ReportingBasePluginConvention

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

Constructor Summary
`ReportingBasePluginConvention(ProjectInternal project)`

Method Summary
`java.lang.String` | `getApiDocTitle()` Returns the title for API documentation for the project.
`java.io.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
java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString()

Constructor Detail

### ReportingBasePluginConvention

    public ReportingBasePluginConvention(ProjectInternal project)

Method Detail

### getApiDocTitle

    public java.lang.String getApiDocTitle()

  Returns the title for API documentation for the project.
  Returns:
    The title. Never returns null.

### getReportsDir

    public java.io.File getReportsDir()

  Returns the directory containing all reports for this project.
  Returns:
    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.
  Returns:
    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.
  Parameters:
    `reportsDirName` - The reports directory name. Should not be null.

Groovy Documentation