[
https://issues.apache.org/jira/browse/BEAM-2306?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Kenneth Knowles updated BEAM-2306:
----------------------------------
Labels: starter triaged (was: starter)
> @Deprecated without @deprecated javadoc explanation should cause build failure
> ------------------------------------------------------------------------------
>
> Key: BEAM-2306
> URL: https://issues.apache.org/jira/browse/BEAM-2306
> Project: Beam
> Issue Type: Bug
> Components: sdk-java-core
> Affects Versions: 2.0.0
> Reporter: Kenneth Knowles
> Priority: Major
> Labels: starter, triaged
>
> We have a number of places with {{@Deprecated}} annotations on seemingly
> innocuous methods, for example in {{CoderRegistry}}, with no accompanying
> {{@deprecated}} javadoc.
> - If there is a preferred alternative, it should be explicitly linked.
> - If there is no alternative, that should be explained.
> - The deprecation should indicate whether it is for removal at version 3.0.0
> or whether it was deprecated prior to 2.0.0 and may be removed at some
> increment 2.x.y.
> I believe javadoc or findbugs has the ability to enforce proper policy. This
> ticket tracks getting that policy in place.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
