Re: draft lithium release plan


Colin Dixon
 

The issue is that I think most people will merely use the API and see if it works without ever looking at the Javadoc or seeing that there's an @Beta.

Ideally, we'd generate a warning for using @Beta functions and force users to add an @SuppressWarnings to use them without warnings. This would make it much more likely that people would realize that they were doing something potentially dangerous and should work out whether they want to keep doing it.

--Colin


On Fri, Oct 31, 2014 at 7:50 AM, Robert Varga <nite@...> wrote:
On 10/29/2014 04:26 PM, Colin Dixon wrote:

Exploring using annotations seems like another great idea, but with the exception of @Deprecated, do any of them show up in a visible way for developers? It seems like we'd need a corresponding Eclipse plugin to help most of our developers understand when they were using different kinds of APIs and the expectations they come with.

Most of these annotations (like @Beta) are @Documented, so they should show up in Javadocs and similar contexts.

Bye,
Robert

Join {TSC@lists.opendaylight.org to automatically receive all group messages.