Field Detail

• public static final String NAME

Property Detail

• Object artifactDescription

Constructor Detail

• JvmCoreExtension(Project project)

Method Detail

• void exposeJavaPackagesInDocs(String[] packages)

  Add packages which should be exposed in GroovyDoc.

  These are packages above and beyond java.lang, java.io and java.net.

  Parameters:

  packages - List of packages.

• void exposeSubprojectInDocs(String pkgName, String projectName)

  Exposes the APIs of a single subproject in the docs of this project.

  Parameters:

  pkgName - Name of package.

  projectName - Name of project.

  Since:

  0.3.0

• void exposeSubprojectsInDocs(java.util.Map<String, String> packages)

  Exposes the APIS of other subprojects in the docs of this project.

  Parameters:

  packages - Mapping where the key is the package name and the value is the project name.

  Since:

  0.3.0

• Provider<String> getArtifactDescription()

  Description of the main artifact produced by this project.

  Returns:

  Description.

• Provider<java.util.List<String>> getJavaPackagesInDocs()

  List of packages for which links can be created in docs.

  Returns:

  List of packages.

• void includeInternalPackages(boolean flag)

  Whether to include the anything that is in package called internal/impl or subpackage thereof.

  Parameters:

  flag - true to include internal packages. (Default is not to include).

  Since:

  0.3.0

• void javaLanguageVersion(int ver)

  Set the language toolchain to use.

  Parameters:

  ver - Version

• void javaLanguageVersion(String ver)

  Set the language toolchain to use.

  Parameters:

  ver - Version

• void setArtifactDescription(Object text)

  Sets a description for the artifact. If not set, will try to read Project.getDescription.

  Parameters:

  test - Description of the main artifact.