Update javadoc for Feature

[magicDGS]

Description

As pointed out in #813, the Feature interface is meant to be a marker for a Locatable with tribble support. This is a simple documentation patch to:

1. point out what is the purpose of this class.
2. add a date note to the deprecation of getChr(). Because of the move to the gradle structure, I cannot pinpoint the exact date of deprecation, but at least we know that is before 2016 May.

The first point is to clarify why tribble is using Feature instead of Locatable (and avoid proposals like #812), and the second is to help in the API evolution (to be able to remove at some point deprecated methods).

Checklist

• Code compiles correctly
• New tests covering changes and new functionality
• All tests passing
• Extended the README / documentation, if necessary
• Is not backward compatible (breaks binary or source compatibility)

[magicDGS]

Can you have a look to this, @droazen? I think that with this change it is clear what is the meaning of the Feature class, and we can avoid proposals like mine. Thank you very much!

[codecov-io]

Codecov Report

Merging #818 into master will increase coverage by 0.006%.
The diff coverage is n/a.

@@               Coverage Diff               @@
##              master      #818       +/-   ##
===============================================
+ Coverage     64.867%   64.873%   +0.006%     
- Complexity      7175      7178        +3     
===============================================
  Files            526       526               
  Lines          31731     31731               
  Branches        5424      5424               
===============================================
+ Hits           20583     20585        +2     
- Misses          8997      8998        +1     
+ Partials        2151      2148        -3

Impacted Files	Coverage Δ	Complexity Δ
src/main/java/htsjdk/tribble/Feature.java	0% <ø> (ø)	0 <0> (ø)	❌
...va/htsjdk/samtools/util/AsyncBufferedIterator.java	68.478% <0%> (-1.087%)	17% <0%> (ø)
...main/java/htsjdk/samtools/SAMRecordSetBuilder.java	89.113% <0%> (+0.806%)	64% <0%> (+2%)	✅
...a/htsjdk/samtools/cram/encoding/rans/Decoding.java	85.714% <0%> (+3.571%)	12% <0%> (+1%)	✅

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d22658...a1674ee. Read the comment docs.

[droazen]

"before 05-2017" -> "on 03/2015"

[magicDGS]

Done.

[droazen]

Might make things clearer to add an extra sentence here: "Marker interface for Locatables with Tribble support. A Feature represents a record in a tribble-supported file format."

[magicDGS]

Done.

[droazen]

Thanks for this @magicDGS -- two comments to address, then we can merge this.

[magicDGS]

Thanks for reviewing, @droazen. Back to you!

[droazen]

👍

[magicDGS]

Thnaks!