Skip to content

Commit

Permalink
Improve javadoc of "includes" and "excludes" (#229)
Browse files Browse the repository at this point in the history
Co-authored-by: Uwe Schindler <uwe@thetaphi.de>
  • Loading branch information
kwin and uschindler authored May 20, 2023
1 parent beaaa9c commit 650b9e6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
6 changes: 4 additions & 2 deletions build.xml
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@
<property file="build.properties" />

<property name="jdk.version" value="1.7"/>
<property name="maven.version" value="2.2.1"/>
<property name="maven-plugin-plugin.version" value="3.4"/>
<property name="maven.version" value="3.2.5"/>
<property name="maven-plugin-plugin.version" value="3.8.1"/>

<!-- with fork=false this somehow takes endless to download the internet, so let's fork - and slow down in an other way (startup) -->
<property name="maven.fork" value="true"/>
Expand Down Expand Up @@ -672,6 +672,8 @@
<exclude name="**/jdk-deprecated-*.txt"/>
<exclude name="**/jdk-internal-*.txt"/>
<exclude name="**/*.iml"/>
<exclude name="**/.project"/>
<exclude name="**/.settings"/>
</fileset>
</rat:report>
<!-- now print the output, for review -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ public abstract class AbstractCheckMojo extends AbstractMojo implements Constant
* signatures that refer to methods or field in classes that are not on classpath,
* e.g. This is useful in multi-module Maven builds where a common set of signatures is used,
* that are not part of every sub-modules dependencies.
* @see #ignoreSignaturesOfMissingClasses)
* @deprecated The setting 'failOnUnresolvableSignatures' was deprecated and will be removed in next version. Use 'ignoreSignaturesOfMissingClasses' instead.
* @see #ignoreSignaturesOfMissingClasses
* @deprecated The setting {@code failOnUnresolvableSignatures} was deprecated and will be removed in next version. Use {@link #ignoreSignaturesOfMissingClasses} instead.
* @since 1.4
*/
@Deprecated
Expand Down Expand Up @@ -196,17 +196,22 @@ public abstract class AbstractCheckMojo extends AbstractMojo implements Constant
private String releaseVersion;

/**
* 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 '**&#47;*.class'
* List of <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant patterns</a> which must match all relative class paths to be considered.
* All relative class paths matching one or more of the given patterns and not matching any of the ones from {@link #excludes} are considered.
* The given paths are relative to {@code classesDirectory}.
* Can be changed to e.g. exclude several files (using {@link #excludes}).
* The default is a single include with pattern {@code **&#47;*.class}.
* @see #excludes
* @since 1.0
*/
@Parameter(required = false)
private String[] includes;

/**
* List of patterns matching class files to be excluded from checking.
* List of <a href="https://ant.apache.org/manual/dirtasks.html#patterns">Ant patterns</a>.
* All relative class paths matching one or more of the given patterns are skipped.
* The given paths are relative to {@code classesDirectory}.
*
* @see #includes
* @since 1.0
*/
Expand Down Expand Up @@ -488,4 +493,4 @@ public void debug(String msg) {
}
}

}
}
3 changes: 3 additions & 0 deletions src/main/maven/pom-build.xml.template
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@
<extractor>java-javadoc</extractor>
<extractor>java-annotations</extractor>
</extractors>
<externalJavadocBaseUrls>
<externalJavadocBaseUrl>https://docs.oracle.com/javase/7/docs/api/</externalJavadocBaseUrl>
</externalJavadocBaseUrls>
</configuration>
</plugin>
<plugin>
Expand Down

0 comments on commit 650b9e6

Please sign in to comment.