Home | About | Sematext search-lucene.com search-hadoop.com
NEW: Monitor These Apps!
elasticsearch, apache solr, apache hbase, hadoop, redis, casssandra, amazon cloudwatch, mysql, memcached, apache kafka, apache zookeeper, apache storm, ubuntu, centOS, red hat, debian, puppet labs, java, senseiDB
 Search Hadoop and all its subprojects:

Switch to Threaded View
Accumulo >> mail # dev >> Encourage the use of @since


Copy link to this message
-
Encourage the use of @since
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
NEW: Monitor These Apps!
elasticsearch, apache solr, apache hbase, hadoop, redis, casssandra, amazon cloudwatch, mysql, memcached, apache kafka, apache zookeeper, apache storm, ubuntu, centOS, red hat, debian, puppet labs, java, senseiDB