Class DocumentationProblemGroup

java.lang.Object

org.gradle.api.problems.ProblemGroup

org.gradle.api.problems.RootProblemGroup

org.gradle.api.problems.DocumentationProblemGroup

@Incubating
public abstract class DocumentationProblemGroup
extends RootProblemGroup

The predefined Documentation root problem group.

Production of documentation of any form, including API docs, manuals, or websites.

The predefined sub-groups are available as properties. Further sub-groups can be created with RootProblemGroup.group(String).

Not intended for subclassing outside of Gradle. New members may be added in future versions.

Since:

9.9.0

See Also:

• ProblemGroups

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocumentationProblemGroup()	Constructor.

Method Summary

Modifier and Type	Method	Description
abstract SecondLevelProblemGroup	getGroovydoc()	The Groovydoc sub-group.
abstract SecondLevelProblemGroup	getJavadoc()	The Javadoc sub-group.
abstract SecondLevelProblemGroup	getScaladoc()	The Scaladoc sub-group.

Methods inherited from class RootProblemGroup

getUndefined, group

Methods inherited from class ProblemGroup

create, create, getDisplayName, getName, getParent

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentationProblemGroup

protected DocumentationProblemGroup()

Constructor.

Since:

9.9.0

Method Details

getJavadoc

public abstract SecondLevelProblemGroup getJavadoc()

The Javadoc sub-group.

Configuration and generation of Javadoc API documentation, including tag validation, doclets, or reference resolution.

Since:

9.9.0

getGroovydoc

public abstract SecondLevelProblemGroup getGroovydoc()

The Groovydoc sub-group.

Configuration and generation of Groovy API documentation, including tag validation, doclets, or reference resolution.

Since:

9.9.0

getScaladoc

public abstract SecondLevelProblemGroup getScaladoc()

The Scaladoc sub-group.

Configuration and generation of Scala API documentation, including tag validation, doclets, or reference resolution.

Since:

9.9.0