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 (JIRA)" <ji...@apache.org> on 2010/03/24 05:14:27 UTC

[jira] Created: (HADOOP-6658) Exclude Private elements from generated Javadoc

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


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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12859502#action_12859502 ] 

Tom White commented on HADOOP-6658:
-----------------------------------

I'd like to commit this soon, since it makes it easier to check API compatibility changes in HADOOP-6668 and MAPREDUCE-1623.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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

Tests now pass, but annotation processing doesn't seem to be working with the new classes. This patch excludes them from annotation processing, since we don't need fault injection for these tools.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12854100#action_12854100 ] 

Tom White commented on HADOOP-6658:
-----------------------------------

Test failures are unrelated. I think this is ready to be committed.

> 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, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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

New patch which excludes annotations that are marked Private or LimitedPrivate. Also removes Javadoc and RAT warnings.

> 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, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12854248#action_12854248 ] 

Tom White commented on HADOOP-6658:
-----------------------------------

Yes, here's the relevant [thread|http://mail-archives.apache.org/mod_mbox/www-legal-discuss/201004.mbox/<l2...@mail.gmail.com>]

> 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, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

          Status: Resolved  (was: Patch Available)
    Hadoop Flags: [Reviewed]
      Resolution: Fixed

I've just committed this.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12849557#action_12849557 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

-1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12439736/HADOOP-6658.patch
  against trunk revision 927193.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    -1 core tests.  The patch failed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/430/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/430/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/430/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/430/console

This message is automatically generated.

> 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
>
>
> 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12852256#action_12852256 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

-1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12439822/HADOOP-6658.patch
  against trunk revision 927979.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    -1 javadoc.  The javadoc tool appears to have generated 1 warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    -1 release audit.  The applied patch generated 2 release audit warnings (more than the trunk's current 1 warnings).

    -1 core tests.  The patch failed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/437/testReport/
Release audit warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/437/artifact/trunk/patchprocess/releaseAuditDiffWarnings.txt
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/437/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/437/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/437/console

This message is automatically generated.

> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Open  (was: Patch Available)

> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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

New version of the doclets that takes a option to specify the stability: -unstable (the default), -evolving, -stable. For example, to exclude evolving APIs you would specify -stable. This is useful for using JDiff to examine compatibility differences.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12855220#action_12855220 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

-1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12441232/HADOOP-6658.patch
  against trunk revision 932115.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    -1 core tests.  The patch failed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/450/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/450/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/450/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/450/console

This message is automatically generated.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

         Priority: Blocker  (was: Major)
    Fix Version/s: 0.21.0

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12853526#action_12853526 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

-1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12440770/HADOOP-6658.patch
  against trunk revision 930096.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    -1 core tests.  The patch failed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/442/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/442/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/442/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/442/console

This message is automatically generated.

> 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, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Doug Cutting (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12854243#action_12854243 ] 

Doug Cutting commented on HADOOP-6658:
--------------------------------------

+1 Looks good to me.  I also saw that you okayed this use of LGPL'd JDiff on legal-discuss@.


> 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, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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
>
>
> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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

Patch for review.

> 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
>
>
> 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12859217#action_12859217 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

-1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12442392/HADOOP-6658.patch
  against trunk revision 934619.

    +1 @author.  The patch does not contain any @author tags.

    +0 tests included.  The patch appears to be a documentation patch that doesn't require tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    -1 core tests.  The patch failed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/468/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/468/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/468/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/468/console

This message is automatically generated.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Hadoop QA (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12859433#action_12859433 ] 

Hadoop QA commented on HADOOP-6658:
-----------------------------------

+1 overall.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12442450/HADOOP-6658.patch
  against trunk revision 934619.

    +1 @author.  The patch does not contain any @author tags.

    +1 tests included.  The patch appears to include 3 new or modified tests.

    +1 javadoc.  The javadoc tool did not generate any warning messages.

    +1 javac.  The applied patch does not increase the total number of javac compiler warnings.

    +1 findbugs.  The patch does not introduce any new Findbugs warnings.

    +1 release audit.  The applied patch does not increase the total number of release audit warnings.

    +1 core tests.  The patch passed core unit tests.

    +1 contrib tests.  The patch passed contrib unit tests.

Test results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/470/testReport/
Findbugs warnings: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/470/artifact/trunk/build/test/findbugs/newPatchFindbugsWarnings.html
Checkstyle results: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/470/artifact/trunk/build/test/checkstyle-errors.html
Console output: http://hudson.zones.apache.org/hudson/job/Hadoop-Patch-h4.grid.sp2.yahoo.net/470/console

This message is automatically generated.

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Tom White updated HADOOP-6658:
------------------------------

    Status: Patch Available  (was: Open)

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Updated: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Tom White (JIRA)" <ji...@apache.org>.
     [ 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

Test failures were due to a xerces jar being pulled onto the classpath for jdiff. It's not needed for compilation, or for the targets that use jdiff, since they use the xerces jar bundled with jdiff. 

> 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
>            Priority: Blocker
>             Fix For: 0.21.0
>
>         Attachments: HADOOP-6658.patch, HADOOP-6658.patch, HADOOP-6658.patch, 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.


[jira] Commented: (HADOOP-6658) Exclude Private elements from generated Javadoc

Posted by "Owen O'Malley (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/HADOOP-6658?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12849743#action_12849743 ] 

Owen O'Malley commented on HADOOP-6658:
---------------------------------------

It would be great if the jdiff stuff could ignore private/limited stuff too...

> 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
>
>
> 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.