[ACCUMULO-3097] Missing documentation on some system iterators

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.5.1, 1.6.0
• Fix Version/s: 1.5.2, 1.6.1, 1.7.0
• Component/s: docs, tserver
• Assignee: Josh Elser
• Reporter: Josh Elser
• Created: 02/Sep/14 17:08
• Updated: 03/Sep/14 17:41
• Resolved: 03/Sep/14 17:41

Description

I keep finding some iterators that include no class-level javadoc. When I'm looking through code I'm not entirely familiar with, I tend to glance over them with a general understanding. The problem is that there are usually intricacies regarding the implementation which the tserver's functionality hinges on.

• HeapIterator
• SynchronizedIterator
• SkippingIterator
• SourceSwitchingIterator

Add some class-level javadoc to these classes.