You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sj...@apache.org on 2022/09/12 20:31:26 UTC
[maven] 01/01: [MNG-7463] Improve documentation about deprecation in Mojo
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MNG-7463
in repository https://gitbox.apache.org/repos/asf/maven.git
commit c5478e7b06bf59f0e7309e8f45b5b6ad70bcceb3
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Mon Sep 12 22:30:46 2022 +0200
[MNG-7463] Improve documentation about deprecation in Mojo
---
.../java/org/apache/maven/plugin/descriptor/MojoDescriptor.java | 8 ++++----
maven-plugin-api/src/main/mdo/plugin.mdo | 6 +++---
2 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java
index f32fbe411..c1f7c7f8f 100644
--- a/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java
+++ b/maven-plugin-api/src/main/java/org/apache/maven/plugin/descriptor/MojoDescriptor.java
@@ -88,8 +88,8 @@ public class MojoDescriptor
private String executeLifecycle;
/**
- * Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated. This will trigger a
- * warning when a user tries to configure a parameter marked as deprecated.
+ * Description with reason of Mojo deprecation. Similar to Javadoc deprecated.
+ * This will trigger a warning when a user tries to use a Mojo marked as deprecated.
*/
private String deprecated;
@@ -170,7 +170,7 @@ public class MojoDescriptor
}
/**
- * @return <code>true</code> if the Mojo is deprecated, <code>false</code> otherwise.
+ * @return Description with reason of a Mojo deprecation.
*/
public String getDeprecated()
{
@@ -178,7 +178,7 @@ public class MojoDescriptor
}
/**
- * @param deprecated <code>true</code> to deprecate the Mojo, <code>false</code> otherwise.
+ * @param deprecated Set description with reason of a Mojo deprecation.
*/
public void setDeprecated( String deprecated )
{
diff --git a/maven-plugin-api/src/main/mdo/plugin.mdo b/maven-plugin-api/src/main/mdo/plugin.mdo
index ee80045df..cfe98f173 100644
--- a/maven-plugin-api/src/main/mdo/plugin.mdo
+++ b/maven-plugin-api/src/main/mdo/plugin.mdo
@@ -290,8 +290,8 @@ under the License.
<version>1.0.0</version>
<type>String</type>
<description>
- Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated. This will
- trigger a warning when a user tries to configure a parameter marked as deprecated.
+ Description with the reason of Mojo deprecation. Similar to Javadoc deprecated.
+ This will trigger a warning when a user tries to use a Mojo marked as deprecated.
</description>
</field>
<field>
@@ -423,7 +423,7 @@ under the License.
<version>1.0.0</version>
<type>String</type>
<description>
- Specify the version when the parameter was deprecated to the API. Similar to Javadoc deprecated.
+ Description with the reason of parameter deprecation. Similar to Javadoc deprecated.
This will trigger a warning when a user tries to configure a parameter marked as deprecated.
</description>
</field>