[MPLUGIN-375] deprecate unsupported Mojo descriptor items (#43)

apache · Oct 18, 2021 · f2c4bef · f2c4bef
1 parent f71d87c
commit f2c4bef
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Mojo.java b/maven-plugin-annotations/src/main/java/org/apache/maven/plugins/annotations/Mojo.java
@@ -71,7 +71,10 @@
     /**
      * execution strategy: <code>once-per-session</code> or <code>always</code>.
      * @return <code>once-per-session</code> or <code>always</code>
+     *
+     * @deprecated unused
      */
+    @Deprecated
     String executionStrategy() default "once-per-session";
 
     /**
@@ -98,7 +101,10 @@
     /**
      * can this Mojo be invoked directly only?
      * @return invoked directly only
+     *
+     * @deprecated unused
      */
+    @Deprecated
     boolean requiresDirectInvocation() default false;
 
     /**
@@ -107,6 +113,10 @@
      */
     boolean requiresOnline() default false;
 
+    /**
+     * @deprecated unused
+     */
+    @Deprecated
     boolean inheritByDefault() default true;
 
     /**

diff --git a/maven-plugin-tools-annotations/src/site/apt/index.apt b/maven-plugin-tools-annotations/src/site/apt/index.apt
@@ -58,13 +58,13 @@ import org.apache.maven.settings.Settings;
 @Mojo( name = "<goal-name>",
        aggregator = <false|true>, 
        configurator = "<role hint>",
-       executionStrategy = "<once-per-session|always>",
-       inheritByDefault = <true|false>,
+       executionStrategy = "<once-per-session|always>", // (unsupported since Maven 3.0)
+       inheritByDefault = <true|false>, // (unsupported since Maven 3.0)
        instantiationStrategy = InstantiationStrategy.<strategy>,
        defaultPhase = LifecyclePhase.<phase>,
        requiresDependencyResolution = ResolutionScope.<scope>,
        requiresDependencyCollection = ResolutionScope.<scope>, // (since Maven 3.0)
-       requiresDirectInvocation = <false|true>,
+       requiresDirectInvocation = <false|true>, // (unsupported since Maven 3.0)
        requiresOnline = <false|true>,
        requiresProject = <true|false>,
        requiresReports = <false|true>, // (unsupported since Maven 3.0)

diff --git a/maven-plugin-tools-java/src/site/apt/index.apt b/maven-plugin-tools-java/src/site/apt/index.apt
@@ -50,13 +50,13 @@ import org.apache.maven.settings.Settings;
  * @aggregator
  * @configurator <roleHint>
  * @execute phase="<phaseName>" lifecycle="<lifecycleId>" goal="<goalName>"
- * @executionStrategy <once-per-session|always>
- * @inheritByDefault <true|false>
+ * @executionStrategy <once-per-session|always> (unsupported since Maven 3.0)
+ * @inheritByDefault <true|false> (unsupported since Maven 3.0)
  * @instantiationStrategy <per-lookup|singleton|keep-alive|poolable>
  * @phase <phaseName>
  * @requiresDependencyResolution <compile|runtime|compile+runtime|test>
  * @requiresDependencyCollection <compile|runtime|compile+runtime|test> (since Maven 3.0)
- * @requiresDirectInvocation <false|true>
+ * @requiresDirectInvocation <false|true> (unsupported since Maven 3.0)
  * @requiresOnline <false|true>
  * @requiresProject <true|false>
  * @requiresReports <false|true> (unsupported since Maven 3.0)