You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/06/13 14:31:00 UTC

[jira] [Commented] (KAFKA-5274) Review and improve AdminClient Javadoc for the first release (KIP-117)

    [ https://issues.apache.org/jira/browse/KAFKA-5274?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16047966#comment-16047966 ] 

ASF GitHub Bot commented on KAFKA-5274:
---------------------------------------

GitHub user ijuma opened a pull request:

    https://github.com/apache/kafka/pull/3316

    [WIP] KAFKA-5274: AdminClient Javadoc improvements

    Also improve the Javadoc for ExtendedSerializer, ExtendedDeserializer
    and InterfaceStability.
    
    Publish Javadoc for common.annotation package, which contains
    InterfaceStability.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/ijuma/kafka kafka-5274-admin-client-javadoc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/kafka/pull/3316.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #3316
    
----
commit 3dd7718b7e0dd176307a1717f3a529594ccdd9f5
Author: Ismael Juma <is...@juma.me.uk>
Date:   2017-06-13T13:56:05Z

    Publish javadoc for common.annotation package
    
    It includes InterfaceStability annotation.

commit f8deae27fa04cdc6fbd62ef55880112e1a4d1a61
Author: Ismael Juma <is...@juma.me.uk>
Date:   2017-06-13T14:09:20Z

    Javadoc for ExtendedSerializer and ExtendedDeserializer and add warning about usage

commit 1cf4cf1414c242714c41e5e2faa61c23f83ca0ab
Author: Ismael Juma <is...@juma.me.uk>
Date:   2017-06-13T14:10:44Z

    Clarify InterfaceStability

commit 7adc0d8297a46d6f61a5451c28fda62fb5ef4ba7
Author: Ismael Juma <is...@juma.me.uk>
Date:   2017-06-13T14:27:46Z

    Various javadoc improvements to API classes introduced for the AdminClient

commit 38ba7beed8685a67e606df3306e225885cc19500
Author: Ismael Juma <is...@juma.me.uk>
Date:   2017-06-13T14:27:53Z

    WIP

----


> Review and improve AdminClient Javadoc for the first release (KIP-117)
> ----------------------------------------------------------------------
>
>                 Key: KAFKA-5274
>                 URL: https://issues.apache.org/jira/browse/KAFKA-5274
>             Project: Kafka
>          Issue Type: Sub-task
>            Reporter: Ismael Juma
>            Assignee: Ismael Juma
>             Fix For: 0.11.0.0
>
>
> Once all the AdminClient pieces are in, we should take a pass at the Javadoc and improve it wherever possible.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)