accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Christopher <ctubb...@apache.org>
Subject Encourage the use of @since
Date Thu, 17 Jan 2013 21:40:42 GMT
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
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message