[
https://issues.apache.org/jira/browse/JAMES-2699?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16800685#comment-16800685
]
Amichai Rothman commented on JAMES-2699:
----------------------------------------
It's great to have it in an upgrade migration doc, didn't think of that... but
I was actually referring to adding this info to the javadoc @deprecated tags so
anyone using the code can see this immediately. Most IDEs and other build tools
mark or warn about usages of deprecated methods... the immediate thing the
developer does is see what the @deprecated tag says about how to deal with the
deprecation.
> Deprecation without documentation
> ---------------------------------
>
> Key: JAMES-2699
> URL: https://issues.apache.org/jira/browse/JAMES-2699
> Project: James Server
> Issue Type: Bug
> Components: Matchers/Mailets (bundled)
> Affects Versions: 3.4.0
> Reporter: Amichai Rothman
> Priority: Major
>
> In the current Mailet API there are many deprecated classes and methods
> marked with the @Deprecated annotation and some also with the @deprecated
> javadoc tag. However, very few of these have any related documentation on
> what to use instead, or at least why it is deprecated if there is no
> alternative. As it is, someone using or implementing the API has no idea what
> the migration path should be to avoid using these deprecated APIs which may
> disappear in the future.
> Please document all deprecations, most importantly with what is the
> recommended way to migrate away from them.
> This may be true for other modules as well, but certainly is in this central
> API.
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org
