From 37ac4c90bb58fc53fa41f4339b610439cbfe0b50 Mon Sep 17 00:00:00 2001 From: Konrad Windszus Date: Wed, 5 Apr 2023 20:32:48 +0200 Subject: [PATCH 1/3] Improve javadoc of "includes" and "excludes" Use newest m-plugin-p 3.8.1 This closes #228 --- build.xml | 6 ++++-- .../forbiddenapis/maven/AbstractCheckMojo.java | 18 ++++++++++++------ src/main/maven/pom-build.xml.template | 3 +++ 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/build.xml b/build.xml index 81db0c20..d1b8b958 100644 --- a/build.xml +++ b/build.xml @@ -105,8 +105,8 @@ - - + + @@ -672,6 +672,8 @@ + + diff --git a/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java b/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java index de754d0f..61ba3734 100644 --- a/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java +++ b/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java @@ -35,6 +35,7 @@ import de.thetaphi.forbiddenapis.ForbiddenApiException; import de.thetaphi.forbiddenapis.Logger; import de.thetaphi.forbiddenapis.ParseException; +import de.thetaphi.forbiddenapis.maven.TestCheckMojo; import java.io.File; import java.io.IOException; @@ -137,8 +138,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 @@ -196,9 +197,11 @@ 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 '**/*.class' + * List of Ant patterns 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 **/*.class}. * @see #excludes * @since 1.0 */ @@ -206,7 +209,10 @@ public abstract class AbstractCheckMojo extends AbstractMojo implements Constant private String[] includes; /** - * List of patterns matching class files to be excluded from checking. + * List of Ant patterns. + * 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 */ diff --git a/src/main/maven/pom-build.xml.template b/src/main/maven/pom-build.xml.template index 53340dc4..16f59bd2 100644 --- a/src/main/maven/pom-build.xml.template +++ b/src/main/maven/pom-build.xml.template @@ -43,6 +43,9 @@ java-javadoc java-annotations + + https://docs.oracle.com/javase/8/docs/api/ + From 1404859ad19c696912be2a804db0fbdebf44fc0b Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Sat, 20 May 2023 20:05:21 +0200 Subject: [PATCH 2/3] Remove import --- .../de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java b/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java index 61ba3734..02b74ee9 100644 --- a/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java +++ b/src/main/java/de/thetaphi/forbiddenapis/maven/AbstractCheckMojo.java @@ -35,7 +35,6 @@ import de.thetaphi.forbiddenapis.ForbiddenApiException; import de.thetaphi.forbiddenapis.Logger; import de.thetaphi.forbiddenapis.ParseException; -import de.thetaphi.forbiddenapis.maven.TestCheckMojo; import java.io.File; import java.io.IOException; @@ -494,4 +493,4 @@ public void debug(String msg) { } } -} \ No newline at end of file +} From 5eaf2bede8e87a206035b9c8c5744a1ef60c530a Mon Sep 17 00:00:00 2001 From: Uwe Schindler Date: Sat, 20 May 2023 20:06:44 +0200 Subject: [PATCH 3/3] We are still on Java 7 --- src/main/maven/pom-build.xml.template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/maven/pom-build.xml.template b/src/main/maven/pom-build.xml.template index 16f59bd2..fec0a25f 100644 --- a/src/main/maven/pom-build.xml.template +++ b/src/main/maven/pom-build.xml.template @@ -44,7 +44,7 @@ java-annotations - https://docs.oracle.com/javase/8/docs/api/ + https://docs.oracle.com/javase/7/docs/api/