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/18 14:37:14 UTC
[maven] branch maven-3.9.x updated: [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 maven-3.9.x
in repository https://gitbox.apache.org/repos/asf/maven.git
The following commit(s) were added to refs/heads/maven-3.9.x by this push:
new a4ed7bb6b [MNG-7463] Improve documentation about deprecation in Mojo
a4ed7bb6b is described below
commit a4ed7bb6ba66ec4d6a471dc1b024c7469e17574d
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Mon Sep 12 22:30:46 2022 +0200
[MNG-7463] Improve documentation about deprecation in Mojo
(cherry picked from commit 47e2d689d687358a85c2cdecc176cac36093817e)
---
.../org/apache/maven/plugin/descriptor/MojoDescriptor.java | 8 ++++----
maven-plugin-api/src/main/mdo/plugin.mdo | 14 +++++++-------
2 files changed, 11 insertions(+), 11 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 a15bdcf0c..35d574bc1 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
@@ -89,8 +89,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 {@code @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 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 0bb1b511e..c1e579604 100644
--- a/maven-plugin-api/src/main/mdo/plugin.mdo
+++ b/maven-plugin-api/src/main/mdo/plugin.mdo
@@ -289,10 +289,10 @@ under the License.
<name>deprecated</name>
<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>
+ <description><![CDATA[
+ Description with the reason of Mojo deprecation. Similar to Javadoc <code>@deprecated</code>
+ This will trigger a warning when a user tries to use a Mojo marked as deprecated.
+ ]]></description>
</field>
<field>
<name>configurator</name>
@@ -422,10 +422,10 @@ under the License.
<name>deprecated</name>
<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><![CDATA[
+ Description with the reason of parameter deprecation. Similar to Javadoc <code>@deprecated</code>
This will trigger a warning when a user tries to configure a parameter marked as deprecated.
- </description>
+ ]]></description>
</field>
</fields>
</class>