+1 on both accounts. Would help alleviate confusion over what is the public api and what is publicly callable.

On 01/17/2013 05:48 PM, Eric Newton wrote:
+1

I also like the idea of tagging the public API.



On Thu, Jan 17, 2013 at 5:07 PM, David Medinets <[email protected]>wrote:

+1

On Thu, Jan 17, 2013 at 4:40 PM, Christopher <[email protected]> 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


Reply via email to