Return-Path: X-Original-To: apmail-accumulo-dev-archive@www.apache.org Delivered-To: apmail-accumulo-dev-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 54F13D20B for ; Thu, 17 Jan 2013 22:48:58 +0000 (UTC) Received: (qmail 41694 invoked by uid 500); 17 Jan 2013 22:48:58 -0000 Delivered-To: apmail-accumulo-dev-archive@accumulo.apache.org Received: (qmail 41672 invoked by uid 500); 17 Jan 2013 22:48:58 -0000 Mailing-List: contact dev-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@accumulo.apache.org Delivered-To: mailing list dev@accumulo.apache.org Received: (qmail 41641 invoked by uid 99); 17 Jan 2013 22:48:56 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 Jan 2013 22:48:56 +0000 X-ASF-Spam-Status: No, hits=1.5 required=5.0 tests=HTML_MESSAGE,RCVD_IN_DNSWL_LOW,SPF_PASS X-Spam-Check-By: apache.org Received-SPF: pass (athena.apache.org: domain of eric.newton@gmail.com designates 74.125.82.180 as permitted sender) Received: from [74.125.82.180] (HELO mail-we0-f180.google.com) (74.125.82.180) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 17 Jan 2013 22:48:51 +0000 Received: by mail-we0-f180.google.com with SMTP id t57so519642wey.25 for ; Thu, 17 Jan 2013 14:48:30 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:x-received:in-reply-to:references:date:message-id :subject:from:to:content-type; bh=Jpw4CBF8LI2IcjinnLOvxo1/djhkQ1Nokw2wiXq2IXM=; b=0lprcr1QLsmlXS0/wfvAHaYlectFq5ejymFKIbGbmzqR4pYLklboQSDEEoEtgs2e5M pWqqQXNXVaCFDSFU7VSm3+zh1osYVNb/HHy7hYgEJIhUHKxcqP06NbviNq1eTx/ivOEU QD9qNgJydenERDfaw/UyEiGpEzk7o+9PUNkhqkC++x0iKaUDVwSl8Syjqwn7oI/NlF6l iV+drRFaNikVLju0TDEICiELlPpLTozYUAhFFSh6nC7KhuWyrz2vpJdI6xBLup2kTA5T fMKQmc2AAEiFUqFkLd9GOES2zQmwKW0iKZDbV/2Nqq9TyMY22OU/UIBnjvn4otjmWxH7 Kyig== MIME-Version: 1.0 X-Received: by 10.180.84.131 with SMTP id z3mr528886wiy.25.1358462910585; Thu, 17 Jan 2013 14:48:30 -0800 (PST) Received: by 10.216.200.221 with HTTP; Thu, 17 Jan 2013 14:48:30 -0800 (PST) In-Reply-To: References: Date: Thu, 17 Jan 2013 17:48:30 -0500 Message-ID: Subject: Re: Encourage the use of @since From: Eric Newton To: dev@accumulo.apache.org Content-Type: multipart/alternative; boundary=f46d043bdd6439da3104d383cb66 X-Virus-Checked: Checked by ClamAV on apache.org --f46d043bdd6439da3104d383cb66 Content-Type: text/plain; charset=ISO-8859-1 +1 I also like the idea of tagging the public API. On Thu, Jan 17, 2013 at 5:07 PM, David Medinets wrote: > +1 > > On Thu, Jan 17, 2013 at 4:40 PM, Christopher wrote: > > I would like to propose and encourage the use of the @since javadoc tag > for > > all new public/protected methods in the public API, as well as new > classes > > in the public API. > > > > I would also like to propose and encourage the words "since " be > > used as the first two words of all @deprecated javadoc tags. > > > > These are enormously useful for documenting to users when a new feature > was > > added/changed, as well as informing developers how long something has > been > > around, and thus informing decisions about when it is safe to remove or > > change. > > > > -- > > Christopher L Tubbs II > > http://gravatar.com/ctubbsii > --f46d043bdd6439da3104d383cb66--