Skip to content

Commit 2d7685d

Browse files
committed
Clarified documentation on BamReader::GetNextAlignmentCore
1 parent b307a39 commit 2d7685d

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/api/BamReader.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// BamReader.cpp (c) 2009 Derek Barnett, Michael Str�mberg
33
// Marth Lab, Department of Biology, Boston College
44
// ---------------------------------------------------------------------------
5-
// Last modified: 18 November 2012 (DB)
5+
// Last modified: 29 July 2013 (DB)
66
// ---------------------------------------------------------------------------
77
// Provides read access to BAM files.
88
// ***************************************************************************
@@ -171,8 +171,8 @@ bool BamReader::GetNextAlignment(BamAlignment& alignment) {
171171
172172
However, this method does NOT populate the alignment's string data fields
173173
(read name, bases, qualities, tags, filename). This provides a boost in speed
174-
when these fields are not required for every alignment. These fields can be
175-
populated 'lazily' (as needed) by calling BamAlignment::BuildCharData() later.
174+
when these fields are not required for every alignment. These fields, excluding filename,
175+
can be populated 'lazily' (as needed) by calling BamAlignment::BuildCharData() later.
176176
177177
\param[out] alignment destination for alignment record data
178178
\returns \c true if a valid alignment was found

0 commit comments

Comments
 (0)