Skip to content

Commit 740dae4

Browse files
committed
[MNG-4840] document requiredMavenVersion in plugin descriptor
1 parent 1fc87b8 commit 740dae4

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

Diff for: api/maven-api-plugin/src/main/mdo/plugin.mdo

+9-3
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,19 @@ under the License.
8989
<field>
9090
<name>requiredJavaVersion</name>
9191
<version>1.1.0+</version>
92-
<description>A version range which specifies the supported Java 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.</description>
92+
<description>
93+
A version range which specifies the supported Java 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.
94+
@since Maven 4.0.0-alpha-3
95+
</description>
9396
<type>String</type>
9497
</field>
9598
<field>
9699
<name>requiredMavenVersion</name>
97-
<version>1.1.0+</version>
98-
<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.</description>
100+
<version>1.0.0+</version>
101+
<description>
102+
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.
103+
@since Maven 3.0.2
104+
</description>
99105
<type>String</type>
100106
</field>
101107
<field xdoc.separator="blank">

Diff for: maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/PluginDescriptor.java

+13
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ public class PluginDescriptor extends ComponentSetDescriptor implements Cloneabl
8181

8282
private String description;
8383

84+
// MNG-4840
8485
private String requiredMavenVersion;
8586

8687
private String requiredJavaVersion;
@@ -367,10 +368,22 @@ public String getDescription() {
367368
return description;
368369
}
369370

371+
/**
372+
* Set required Maven version.
373+
*
374+
* @param requiredMavenVersion Maven version required by the plugin
375+
* @since 3.0.2
376+
*/
370377
public void setRequiredMavenVersion(String requiredMavenVersion) {
371378
this.requiredMavenVersion = requiredMavenVersion;
372379
}
373380

381+
/**
382+
* Get required Maven version.
383+
*
384+
* @return the Maven version required by the plugin
385+
* @since 3.0.2
386+
*/
374387
public String getRequiredMavenVersion() {
375388
return requiredMavenVersion;
376389
}

0 commit comments

Comments
 (0)