Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 37E8C200CCA for ; Wed, 19 Jul 2017 18:29:06 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 3627D16957E; Wed, 19 Jul 2017 16:29:06 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 7C4A4169579 for ; Wed, 19 Jul 2017 18:29:05 +0200 (CEST) Received: (qmail 43022 invoked by uid 500); 19 Jul 2017 16:29:04 -0000 Mailing-List: contact commits-help@beam.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@beam.apache.org Delivered-To: mailing list commits@beam.apache.org Received: (qmail 43013 invoked by uid 99); 19 Jul 2017 16:29:04 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd4-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 19 Jul 2017 16:29:04 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd4-us-west.apache.org (ASF Mail Server at spamd4-us-west.apache.org) with ESMTP id 4E706C0350 for ; Wed, 19 Jul 2017 16:29:04 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd4-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -99.202 X-Spam-Level: X-Spam-Status: No, score=-99.202 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd4-us-west.apache.org [10.40.0.11]) (amavisd-new, port 10024) with ESMTP id Y9p1Bn4esOZF for ; Wed, 19 Jul 2017 16:29:03 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-eu.apache.org (ASF Mail Server at mx1-lw-eu.apache.org) with ESMTP id F01E65FBC6 for ; Wed, 19 Jul 2017 16:29:02 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id E1FBBE0E4D for ; Wed, 19 Jul 2017 16:29:01 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 5D30C21EBA for ; Wed, 19 Jul 2017 16:29:00 +0000 (UTC) Date: Wed, 19 Jul 2017 16:29:00 +0000 (UTC) From: "ASF GitHub Bot (JIRA)" To: commits@beam.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (BEAM-2306) @Deprecated without @deprecated javadoc explanation should cause build failure MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 archived-at: Wed, 19 Jul 2017 16:29:06 -0000 [ https://issues.apache.org/jira/browse/BEAM-2306?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16093368#comment-16093368 ] ASF GitHub Bot commented on BEAM-2306: -------------------------------------- Github user asfgit closed the pull request at: https://github.com/apache/beam/pull/3531 > @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)