hadoop-common-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Tom White (JIRA)" <j...@apache.org>
Subject [jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc
Date Thu, 25 Mar 2010 20:21:27 GMT

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

Tom White updated HADOOP-6658:

    Attachment: HADOOP-6658.patch

Here's a new patch that excludes private elements from JDiff as well.

I tested this by running "ant -Djdiff.stable=0.20.0 api-report" and visually checking that
a new class with the Private annotation (FtpConfigKeys) did not appear.

> Exclude Private elements from generated Javadoc
> -----------------------------------------------
>                 Key: HADOOP-6658
>                 URL: https://issues.apache.org/jira/browse/HADOOP-6658
>             Project: Hadoop Common
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Tom White
>            Assignee: Tom White
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch
> Packages, classes and methods that are marked with the InterfaceAudience.Private or InterfaceAudience.LimitedPrivate
annotation should not appear in the public Javadoc. Developer Javadoc generated using the
"javadoc-dev" ant target should continue to generate Javadoc for all program elements.

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

View raw message