[ https://issues.apache.org/jira/browse/BEAM-2306?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16080128#comment-16080128
]
ASF GitHub Bot commented on BEAM-2306:
--------------------------------------
GitHub user alex-filatov opened a pull request:
https://github.com/apache/beam/pull/3531
[BEAM-2306] Fail build when @Deprecated is used without @deprecated javadoc
Add checkstyle check to fail the build when @Deprecated is used without @deprecated javadoc
(or vice versa).
The check is disabled for existing violations where reason for deprecation and/or alternative
is not clear.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/alex-filatov/beam beam-2306-check-missing-deprecated
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/beam/pull/3531.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #3531
----
commit 0694dcc62a28a98363cdd67a69e3f2c3ce82e072
Author: Alex Filatov <alex-filatov@users.noreply.github.com>
Date: 2017-07-10T10:20:49Z
[BEAM-2306] Add checkstyle check to fail the build when @Deprecated is used without @deprecated
javadoc (or vice versa).
The check is disabled for existing violations where reason for deprecation and/or alternative
is not clear.
----
> @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
> Labels: starter
>
> 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
(v6.4.14#64029)