updated javadoc

samtools · Oct 24, 2016 · 58f4154 · 58f4154
1 parent 17fb671
commit 58f4154
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/main/java/htsjdk/samtools/util/SequenceUtil.java b/src/main/java/htsjdk/samtools/util/SequenceUtil.java
@@ -890,10 +890,11 @@ public static byte[] calculateMD5(final byte[] data, final int offset, final int
     /**
      * Calculate MD and NM similarly to Samtools, except that N->N is a match.
      *
-     * @param record
-     * @param ref
-     * @param calcMD
-     * @return
+     * @param record Input record for which to calculate NM and MD.
+     *               The appropriate tags will be added/updated in the record
+     * @param ref    The reference bases for the sequence to which the record is mapped
+     * @param calcMD A flag indicating whether to update the MD tag in the record
+     * @param calcNM A flag indicating whether to update the NM tag in the record
      */
     public static void calculateMdAndNmTags(final SAMRecord record, final byte[] ref,
                                             final boolean calcMD, final boolean calcNM) {