[HBASE-523] package-level javadoc should have example client

• Type: Wish
• Status: Closed
• Priority: Blocker
• Resolution: Fixed
• Affects Version/s: 0.2.0
• Fix Version/s: 0.2.0
• Component/s: documentation

Environment

Applies to all platform

• Assignee: Bryan Duxbury
• Reporter: Bryan Duxbury
• Created: 17/Mar/08 19:16
• Updated: 22/Aug/08 21:13
• Resolved: 08/Apr/08 22:22

Description

Package-level javadoc should have example client or at least point at the FAQ that ties to package release.
For example, the BatchUpdate example code appears in the FAQ sample code, but it is missing in the javadoc.
It will be better to tie the example code snippet with the new methods that replaces the deprecated methods which
will also be tied to release in the javadoc.

Issue Links

• is a clone of: HBASE-482 package-level javadoc should have example client or at least point at the FAQ
• is blocked by: HBASE-521 Improve client scanner interface