Re: API Annotations

2014-12-18 Thread Jay Kreps
Yes, exactly--the goal is to just publish the javadoc on the public classes and all methods on a public class are considered public. Right now we really haven't done proper docs for the new producer--no javadoc and no examples either. This needs to get done before 0.8.2. The idea of an @Experiment

Re: API Annotations

2014-12-18 Thread Gwen Shapira
Thanks for the comments, Joe and Jay. Doing the public / private designation at package level is definitely easier than going method-by-method :) If I get your comments right, the idea is to publish java docs for the public apis on our website (or archive.apache.org) and not publish java docs for

Re: API Annotations

2014-12-16 Thread Jay Kreps
Hey Gwen, We discussed this a bit about this when starting on the new clients. We were super sloppy about this in initial Kafka development--single jar, no real differentiation between public and private apis. The plan was something like the following: 1. Start to consider this with the new clie

Re: API Annotations

2014-12-16 Thread Joe Stein
This is definitely an area we can improve upon, thanks for bringing it up Gwen. We should also decide on structure for how we publish too that has not been something I have been consistent about for each release that should be standard. We can publish to SVN but I always feel like drift happens th

API Annotations

2014-12-16 Thread Gwen Shapira
Hi, Kafka has public APIs in Java and Scala, intended for use by external developers. In addition, Kafka also exposes many public methods that are intended to use within Kafka but are not intended to be called by external developers. Also, some of the external APIs are less stable than others (the