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/14 22:03:59 UTC
[maven] branch MNG-7463-3.9 created (now 521363201)
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a change to branch MNG-7463-3.9
in repository https://gitbox.apache.org/repos/asf/maven.git
at 521363201 [MNG-7463] Improve documentation about deprecation in Mojo
This branch includes the following new commits:
new 521363201 [MNG-7463] Improve documentation about deprecation in Mojo
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[maven] 01/01: [MNG-7463] Improve documentation about deprecation in Mojo
Posted by sj...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
sjaranowski pushed a commit to branch MNG-7463-3.9
in repository https://gitbox.apache.org/repos/asf/maven.git
commit 521363201478079e605c04a6621b2e2be875aa94
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>