[jira] [Commented] (MNG-7463) Improve documentation about deprecation in Mojo

[ASF GitHub Bot (Jira)]

    [ 
https://issues.apache.org/jira/browse/MNG-7463?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17584847#comment-17584847
 ] 

ASF GitHub Bot commented on MNG-7463:
-------------------------------------

michael-o commented on code in PR #319:
URL: https://github.com/apache/maven-site/pull/319#discussion_r954965632


##########
content/xdoc/developers/mojo-api-specification.xml:
##########
@@ -588,9 +588,9 @@ under the License.
           <td><code>deprecated</code></td>
           <td><code>@deprecated &lt;deprecated-text&gt;</code></td>
           <td>No</td>
-          <td>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.</td>
+          <td>Description with the reason of Mojo depreciation. Similar to 
Javadoc deprecated.

Review Comment:
   deprecation



##########
content/xdoc/developers/mojo-api-specification.xml:
##########
@@ -588,9 +588,9 @@ under the License.
           <td><code>deprecated</code></td>
           <td><code>@deprecated &lt;deprecated-text&gt;</code></td>
           <td>No</td>
-          <td>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.</td>
+          <td>Description with the reason of Mojo depreciation. Similar to 
Javadoc deprecated.
+            This will trigger a warning when a user tries to use Mojo marked 
as deprecated.

Review Comment:
   use a Mojo



##########
content/xdoc/developers/mojo-api-specification.xml:
##########
@@ -731,9 +731,9 @@ under the License.
           <td><code>deprecated</code></td>
           <td><code>@deprecated &lt;deprecated-text&gt;</code></td>
           <td>No</td>
-          <td>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.</td>
+          <td>Description with the reason of parameter depreciation. Similar 
to Javadoc deprecated.

Review Comment:
   same here





> Improve documentation about deprecation in Mojo
> -----------------------------------------------
>
>                 Key: MNG-7463
>                 URL: https://issues.apache.org/jira/browse/MNG-7463
>             Project: Maven
>          Issue Type: Improvement
>          Components: Documentation:  General, Plugin API
>            Reporter: Slawomir Jaranowski
>            Assignee: Slawomir Jaranowski
>            Priority: Major
>             Fix For: 3.9.0-candidate
>
>
> fix, improve:
> - java docs of {{org.apache.maven.plugin.descriptor.MojoDescriptor}} 
> -- {{deprecated}} filed and set/get methods.
> - maven-plugin-api/src/main/mdo/plugin.mdo 
> -- descriptions of mojo, parameters deprecated field
> - https://maven.apache.org/developers/mojo-api-specification.html
> -- descriptions of mojo, parameters deprecated 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)