From 2d7685d2aeedd11c46ad3bd67886d9ed65c30f3e Mon Sep 17 00:00:00 2001 From: Derek Barnett Date: Mon, 29 Jul 2013 17:14:01 -0400 Subject: [PATCH] Clarified documentation on BamReader::GetNextAlignmentCore --- src/api/BamReader.cpp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/api/BamReader.cpp b/src/api/BamReader.cpp index 0728d96..c4f0432 100644 --- a/src/api/BamReader.cpp +++ b/src/api/BamReader.cpp @@ -2,7 +2,7 @@ // BamReader.cpp (c) 2009 Derek Barnett, Michael Str�mberg // Marth Lab, Department of Biology, Boston College // --------------------------------------------------------------------------- -// Last modified: 18 November 2012 (DB) +// Last modified: 29 July 2013 (DB) // --------------------------------------------------------------------------- // Provides read access to BAM files. // *************************************************************************** @@ -171,8 +171,8 @@ bool BamReader::GetNextAlignment(BamAlignment& alignment) { However, this method does NOT populate the alignment's string data fields (read name, bases, qualities, tags, filename). This provides a boost in speed - when these fields are not required for every alignment. These fields can be - populated 'lazily' (as needed) by calling BamAlignment::BuildCharData() later. + when these fields are not required for every alignment. These fields, excluding filename, + can be populated 'lazily' (as needed) by calling BamAlignment::BuildCharData() later. \param[out] alignment destination for alignment record data \returns \c true if a valid alignment was found -- 2.39.2