Shl edit samrecord docs #782

Merged
merged 3 commits into from Jan 20, 2017
Jump to file or symbol
Failed to load files and symbols.
+6 −3
Split
@@ -572,14 +572,16 @@ protected static String resolveNameFromIndex(final int referenceIndex, final SAM
}
/**
- * @return 1-based inclusive leftmost position of the clipped sequence, or 0 if there is no position.
+ * @return 1-based inclusive leftmost position of the sequence remaining after clipping, or 0
+ * if there is no position, e.g. for unmapped read.
*/
public int getAlignmentStart() {
return mAlignmentStart;
}
/**
- * @param value 1-based inclusive leftmost position of the clipped sequence, or 0 if there is no position.
+ * @param value 1-based inclusive leftmost position of the sequence remaining after clipping or 0
+ * if there is no position, e.g. for unmapped read.
*/
public void setAlignmentStart(final int value) {
mAlignmentStart = value;
@@ -590,7 +592,8 @@ public void setAlignmentStart(final int value) {
}
/**
- * @return 1-based inclusive rightmost position of the clipped sequence, or 0 read if unmapped.
+ * @return 1-based inclusive rightmost position of the sequence remaining after clipping or 0
+ * if there is no position, e.g. for unmapped read.
*/
public int getAlignmentEnd() {
if (getReadUnmappedFlag()) {