[MNG-4840] fix requiredMavenVersion description #1445

apache · Apr 14, 2024 · fba2542 · fba2542
1 parent d075fe7
commit fba2542
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/api/maven-api-plugin/src/main/mdo/plugin.mdo b/api/maven-api-plugin/src/main/mdo/plugin.mdo
@@ -97,10 +97,10 @@ under the License.
         </field>
         <field>
           <name>requiredMavenVersion</name>
-          <version>1.0.0+</version>
+          <version>1.1.0+</version>
           <description>
             A version range which specifies the supported Maven versions. A version range can either use the usual mathematical syntax "[2.0.10,2.1.0),[3.0,)" or use a single version "2.2.1". The latter is a short form for "[2.2.1,)", i.e. denotes the minimum version required. This value takes precedence over the POMs Maven prerequisite.
-            @since Maven 3.0.2
+            @since Maven 4.0.0-alpha-3
           </description>
           <type>String</type>
         </field>

diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java
@@ -81,7 +81,6 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl
 
     private String description;
 
-    // MNG-4840
     private String requiredMavenVersion;
 
     private String requiredJavaVersion;
@@ -369,17 +368,21 @@ public String getDescription() {
     }
 
     /**
-     * Set required Maven version.
+     * Set required Maven version, as defined in plugin's pom.xml since 3.0.2,
+     * as defined in plugin.xml since 4.0.0-alpha-3.
      *
      * @param requiredMavenVersion Maven version required by the plugin
      * @since 3.0.2
      */
+    // used by maven-core's org.apache.maven.plugin.internal.DefaultMavenPluginManager#getPluginDescriptor(...)
+    // and PluginDescriptorBuilder since 4.0.0-alpha-3
     public void setRequiredMavenVersion(String requiredMavenVersion) {
         this.requiredMavenVersion = requiredMavenVersion;
     }
 
     /**
-     * Get required Maven version.
+     * Get required Maven version, as defined in plugin's pom.xml since 3.0.2,
+     * as defined in plugin.xml since 4.0.0-alpha-3.
      *
      * @return the Maven version required by the plugin
      * @since 3.0.2

diff --git a/...-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java b/...-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptorBuilder.java
@@ -41,6 +41,9 @@
 import org.codehaus.plexus.configuration.PlexusConfigurationException;
 
 /**
+ * Build plugin descriptor object from {@code plugin.xml}.
+ *
+ * @author Jason van Zyl
  */
 public class PluginDescriptorBuilder {