You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Herve Boutemy (Jira)" <ji...@apache.org> on 2022/10/15 10:23:00 UTC

[jira] [Commented] (MPLUGIN-396) Allow only @Deprecated annotation without @deprecated javadoc tag

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

Herve Boutemy commented on MPLUGIN-396:
---------------------------------------

notice https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Deprecated.html
"The @Deprecated annotation should always be present if the @deprecated javadoc tag is present, and vice-versa."

> Allow only @Deprecated annotation without @deprecated javadoc tag
> -----------------------------------------------------------------
>
>                 Key: MPLUGIN-396
>                 URL: https://issues.apache.org/jira/browse/MPLUGIN-396
>             Project: Maven Plugin Tools
>          Issue Type: Improvement
>            Reporter: Slawomir Jaranowski
>            Assignee: Slawomir Jaranowski
>            Priority: Major
>             Fix For: 3.7.0
>
>
> Currently to effective deprecate Mojo parameters we must define both {{@Deprecated}} annotation and {{@deprecated}} javadoc tag.
> Definition must be:
> {code:java}
>     /**
>      * A parameter description
>      *
>      * @deprecated
>      */
>     @Deprecated
>     @Parameter
>     private String param;
> {code}
> should be allowed as:
> {code:java}
>     @Deprecated
>     @Parameter
>     private String param;
> {code}



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