DocumentationProblemGroup

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 group.

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

9.9.0

Functions

open fun create(name: String, displayName: String): ProblemGroup

Creates a new root problem group i.e.

open fun create(name: String, displayName: String, @Nullable parent: @Nullable ProblemGroup): ProblemGroup

Creates a new problem group.

Returns a human-readable label describing the group.

The Groovydoc sub-group.

The Javadoc sub-group.

abstract fun getName(): String

The name of the problem group.

@Nullable

abstract fun getParent(): @Nullable ProblemGroup

Returns the parent group or null for root groups.

The Scaladoc sub-group.

The synthetic Undefined sub-group for problems without an explicitly defined sub-group below this root group.

Returns the sub-group with the given name, creating it if it is not one of the predefined sub-groups.