Skip to content

Clarify Maven configuration parameter "includes" and "excludes" #228

Closed
@kwin

Description

@kwin

Currently the javadoc of includes and excludes (

/**
* List of patterns matching all class files to be parsed from the classesDirectory.
* Can be changed to e.g. exclude several files (using excludes).
* The default is a single include with pattern '**/*.class'
* @see #excludes
* @since 1.0
*/
@Parameter(required = false)
private String[] includes;
/**
* List of patterns matching class files to be excluded from checking.
* @see #includes
* @since 1.0
*/
@Parameter(required = false)
private String[] excludes;
) only refer to generic pattern. It should be clarified that this is not a regular expression pattern but an Ant-style one (https://ant.apache.org/manual/dirtasks.html#patterns). Additionally it should be clarified that this is matched against the relative path of the class file (relative to build.outputDirectory, https://maven.apache.org/ref/3.9.1/maven-model/maven.html#build).

Those javadocs are used to generate the Maven site documentation at https://jenkins.thetaphi.de/job/Forbidden-APIs/javadoc/check-mojo.html#excludes.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions