You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-issues@hadoop.apache.org by "Tom White (Commented) (JIRA)" <ji...@apache.org> on 2011/10/29 23:13:32 UTC

[jira] [Commented] (HADOOP-7782) Add a way to merge javadocs?

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

Tom White commented on HADOOP-7782:
-----------------------------------

The short answer is "mvn javadoc:aggregate -Dmaxmemory=1024". However, we should only publish the public API, which means we should use the annotation-aware doclet, and we should group the API by project using the groups parameter. 

More at http://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate.html and http://maven.apache.org/plugins/maven-javadoc-plugin/aggregate-mojo.html

I can look at this one if you like.

                
> Add a way to merge javadocs?
> ----------------------------
>
>                 Key: HADOOP-7782
>                 URL: https://issues.apache.org/jira/browse/HADOOP-7782
>             Project: Hadoop Common
>          Issue Type: Bug
>          Components: build
>            Reporter: Arun C Murthy
>            Priority: Critical
>
> With 'mvn javadoc:javadoc' we now get docs spread over the maven modules. Is there a way to stich them all together?
> Also, there are some differences in their generation: hadoop-auth and hadoop-yarn-* hadoop-mapreduce-* modules goto a top-level apidocs dir which isn't the case for hadoop-common and hadoop-hdfs - they go straight to target/site/api.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira