[HBASE-9517] Include only InterfaceAudiencePublic elements in generated Javadoc

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.95.2
• Fix Version/s: 0.98.0, 0.96.0
• Component/s: documentation
• Hadoop Flags: Reviewed

Release Note

This updates the javadoc build so that there are two versions of the javadoc generated -- one version that contains the full internal apis of hbase, and another that only includes the @InterfaceAudience.Public API that users and applications will have stronger guarantees on for compatibility between major and minor versions. The original api location on the website will contain the more limited api while a new link off the main page will point to the full internal api.

• Assignee: Jonathan Hsieh
• Reporter: Jonathan Hsieh
• Created: 12/Sep/13 06:14
• Updated: 20/Nov/15 11:54
• Resolved: 13/Sep/13 00:04

Description

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.