kafka-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (KAFKA-3717) Support building aggregate javadoc for all project modules
Date Tue, 17 May 2016 21:24:13 GMT

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

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

GitHub user ijuma opened a pull request:

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

    KAFKA-3717; Support building aggregate javadoc for all project modules

    The task is called `javadocAll` and the generated html will be under `<project.dir>/build/docs/javadoc/`.
    
    I disabled javadoc for `tools` and `log4j-appender` as they are not public API.

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

    $ git pull https://github.com/ijuma/kafka kafka-3717-aggregate-javadoc

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

    https://github.com/apache/kafka/pull/1398.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 #1398
    
----
commit bbf1626e53eb179b604c85aacca8b22226e731bf
Author: Ismael Juma <ismael@juma.me.uk>
Date:   2016-05-17T21:16:35Z

    Support aggregate javadoc task via `javadocAll`

----


> Support building aggregate javadoc for all project modules
> ----------------------------------------------------------
>
>                 Key: KAFKA-3717
>                 URL: https://issues.apache.org/jira/browse/KAFKA-3717
>             Project: Kafka
>          Issue Type: Bug
>            Reporter: Gwen Shapira
>            Assignee: Ismael Juma
>
> If you run "./gradlew javadoc", you will only get JavaDoc for the High Level Consumer.
All the new clients are missing.
> See here: http://home.apache.org/~gwenshap/0.10.0.0-rc5/javadoc/
> I suggest fixing in 0.10.0 branch and in trunk, not rolling a new release candidate,
but updating our docs site.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message