hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Hsieh (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (HBASE-9585) Update javadoc builder in pom to exclude empty packages in user api javadoc
Date Fri, 20 Sep 2013 06:29:54 GMT

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

Jonathan Hsieh edited comment on HBASE-9585 at 9/20/13 6:28 AM:
----------------------------------------------------------------

The original patch is the only way we can do it to get the result that we want via pom configuration.

I tried using mvn <subpackages> tag but it is recursively inclusive. [1] The mvn <excludePackageNames>
tag is recursively inclusive but applied after the subpackages tag adds package.  [2].  These
are essentially just passed to the javadoc commands cmd line args.

[1] http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#subpackages
[2] http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames
                
      was (Author: jmhsieh):
    The original patch is the only we can do to get the result that we want via pom configuration.

I tried using mvn <subpackages> tag but it is recursively inclusive. [1] The mvn <excludePackageNames>
tag is recursively inclusive but applied after the subpackages tag adds package.  [2].  These
are essentially just passed to the javadoc commands cmd line args.

[1] http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#subpackages
[2] http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames
                  
> Update javadoc builder in pom to exclude empty packages in user api javadoc
> ---------------------------------------------------------------------------
>
>                 Key: HBASE-9585
>                 URL: https://issues.apache.org/jira/browse/HBASE-9585
>             Project: HBase
>          Issue Type: Sub-task
>          Components: documentation
>            Reporter: Jonathan Hsieh
>            Assignee: Jonathan Hsieh
>         Attachments: hbase-9585.patch, user-javadoc.png
>
>
> There are many packages that have no apis exposed but are present in the javadoc after
the @InterfaceAudience.Public apis.  Make them go away.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message