Kafka API docs

[Manoj Khangaonkar <kh...@gmail.com>]

Hi,

The API description at http://kafka.apache.org/documentation.html#api is
rather thin -- when you are used to the API docs of other apache projects
like hadoop , cassandra , tomcat etc etc.

Is there a comprehensive API description somewhere (like javadocs) ?

Besides looking at the source code, what are users doing to get a handle on
the full feature set of the Kafka API ?

regards
-- 
http://khangaonkar.blogspot.com/

Re: Kafka API docs

[Neha Narkhede <ne...@gmail.com>]

Hi Manoj,

Thanks for the feedback. We agree that javadocs are a must. As Jun
mentioned, we are working on adding extensive javadocs to our new clients.
The new producer javadoc, once released in 0.8.2, will look like
http://empathybox.com/kafka-javadoc/
The new consumer javadoc, once released in 0.9, will look like
http://people.apache.org/~nehanarkhede/kafka-0.9-consumer-javadoc/doc/

Hope that is useful!

Thanks,
Neha


On Thu, Apr 10, 2014 at 8:14 PM, Jun Rao <ju...@gmail.com> wrote:

> We don't have good java docs right now. We are rewriting both the producer
> and the consumer and will have better javadoc then. For now, following the
> examples in the documentation is probably your best option.
>
> Thanks,
>
> Jun
>
>
> On Thu, Apr 10, 2014 at 11:43 AM, Manoj Khangaonkar
> <kh...@gmail.com>wrote:
>
> > Hi,
> >
> > The API description at http://kafka.apache.org/documentation.html#api is
> > rather thin -- when you are used to the API docs of other apache projects
> > like hadoop , cassandra , tomcat etc etc.
> >
> > Is there a comprehensive API description somewhere (like javadocs) ?
> >
> > Besides looking at the source code, what are users doing to get a handle
> on
> > the full feature set of the Kafka API ?
> >
> > regards
> > --
> > http://khangaonkar.blogspot.com/
> >
>

Re: Kafka API docs

[Jun Rao <ju...@gmail.com>]

We don't have good java docs right now. We are rewriting both the producer
and the consumer and will have better javadoc then. For now, following the
examples in the documentation is probably your best option.

Thanks,

Jun


On Thu, Apr 10, 2014 at 11:43 AM, Manoj Khangaonkar
<kh...@gmail.com>wrote:

> Hi,
>
> The API description at http://kafka.apache.org/documentation.html#api is
> rather thin -- when you are used to the API docs of other apache projects
> like hadoop , cassandra , tomcat etc etc.
>
> Is there a comprehensive API description somewhere (like javadocs) ?
>
> Besides looking at the source code, what are users doing to get a handle on
> the full feature set of the Kafka API ?
>
> regards
> --
> http://khangaonkar.blogspot.com/
>