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] [Updated] (HBASE-9517) Include only InterfaceAudiencePublic elements in generated Javadoc
Date Thu, 12 Sep 2013 18:06:52 GMT

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

Jonathan Hsieh updated HBASE-9517:

    Attachment: hbase-9517.patch

updated pom so that we build a public facing user api javadoc set and also an internals exposed
javadoc set.  I've updated the web page also so that the old links point to the limited user
api and added a link to the new devapi.

The section removed is not needed -- executing {{mvn site -DskipTests}} or {{mvn javadoc:aggregate}}
produces javadoc though now the live in ./target/site/apidocs (or ./target/site/devapidocs).
> Include only InterfaceAudiencePublic elements in generated Javadoc
> ------------------------------------------------------------------
>                 Key: HBASE-9517
>                 URL: https://issues.apache.org/jira/browse/HBASE-9517
>             Project: HBase
>          Issue Type: Sub-task
>          Components: documentation
>    Affects Versions: 0.95.2
>            Reporter: Jonathan Hsieh
>            Assignee: Jonathan Hsieh
>             Fix For: 0.96.0
>         Attachments: hbase-9517.patch
> We should generate two sets of javadoc a la HADOOP-6658 -- one for api users that excludes
all InterfaceAudiencePrivate apis, and one for hbase core developers.  Eventually when we
tighten up the other modules we might add another for coproc developers, and other custom
3rd party pluggable elements.

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

View raw message