hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tom White (Updated) (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HADOOP-7782) Add a way to merge javadocs?
Date Mon, 31 Oct 2011 21:07:32 GMT

     [ https://issues.apache.org/jira/browse/HADOOP-7782?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Tom White updated HADOOP-7782:
------------------------------

    Attachment: HADOOP-7782.patch

I've added a reporting section to the top-level pom, so "mvn site" will generate aggregated
Javadoc.

I've added package-level InterfaceAudience annotations to hide non-public APIs in new packages
- mainly MR2/YARN (which is why the patch is so big).

I've also added a slightly modified doclet to only include classes that have been explicitly
marked @Public (IncludePublicAnnotationsStandardDoclet). Being conservative about what's in
the public API is probably a good thing, since its easier to add a class at a later date than
to remove one. This is basically done, but there may be a few places where InterfaceAudience
should be added.
                
> 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
>            Assignee: Tom White
>            Priority: Critical
>         Attachments: HADOOP-7782.patch
>
>
> 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

        

Mime
View raw message