Class for storing the settings for the javadoc closure.
| Type | Name and description |
|---|---|
ConfigurableFileCollection |
additionalClasspathFilesList of additional class paths used to resolve type references in the source codes. |
ConfigurableFileCollection |
additionalSourceFilesList of additional source files to be included in the Javadoc. |
List<String> |
excludesSet of patterns for files to be excluded from Javadoc. |
boolean |
failOnErrorIf set to true, aborts the Javadoc generation if there are errors in the Javadoc
comments. |
JavadocMemberLevel |
javadocMemberLevelSpecifies which members are included in the Javadoc based on their visibility level. |
String |
javadocTitleThe javadocTitle of the Javadoc to be generated. |
File |
optionsFileFile containing a list of additional Javadoc tool options. |
File |
outputZipFileThe zip file to where the Javadoc will be stored. |
com.android.build.gradle.api.BaseVariant |
variantThe build variant of the module for which Javadoc will be configured. |
String |
windowTitleThe title to be displayed on the browser window. |
List of additional class paths used to resolve type references in the source codes. This property is optional. The variant's classpath as well as the Android library are already included, so there's no need to add them in this property.
List of additional source files to be included in the Javadoc. This property is optional. The variant's source files are already included, so there's no need to add them in this property.
Set of patterns for files to be excluded from Javadoc. This property is optional.
If set to true, aborts the Javadoc generation if there are errors in the Javadoc
comments. Otherwise, attempt to continue. This property is optional and is
false by default.
Specifies which members are included in the Javadoc based on their visibility level. This
value maps to the -public, -protected, -package and -private
options of the javadoc executable. This property is optional and defaults to
JavadocMemberLevel.PROTECTED.
The javadocTitle of the Javadoc to be generated. This property is optional.
File containing a list of additional Javadoc tool options. This property is optional.
The zip file to where the Javadoc will be stored. If this points to an existing file, that file will be overwritten. This property is mandatory.
The build variant of the module for which Javadoc will be configured. This property is mandatory.
The title to be displayed on the browser window. This property is optional.