accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Medinets <david.medin...@gmail.com>
Subject Re: Encourage the use of @since
Date Thu, 17 Jan 2013 22:07:31 GMT
+1

On Thu, Jan 17, 2013 at 4:40 PM, Christopher <ctubbsii@apache.org> 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 <version>" 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

Mime
View raw message