Changed platform check to use standard cmake variable (issue #66)

[bamtools.git] / src / api / BamMultiReader.cpp

diff --git a/src/api/BamMultiReader.cpp b/src/api/BamMultiReader.cpp
index 57c826daa80ccd5368bc0cde3c7254d1f417f496..5c2a0657a71a8530cb59ae238718afaa688c684d 100644 (file)
--- a/src/api/BamMultiReader.cpp
+++ b/src/api/BamMultiReader.cpp
@@ -23,19 +23,22 @@ using namespace std;
 /*! \class BamTools::BamMultiReader
     \brief Convenience class for reading multiple BAM files.
 */
-
 /*! \enum BamMultiReader::MergeOrder
-    \brief A description of the enum type.
+    \brief Used to describe the merge strategy of the BamMultiReader.
+
+    The merge strategy determines which alignment is 'next' from across
+    all opened BAM files.
+*/
+/*! \var BamMultiReader::MergeOrder BamMultiReader::RoundRobinMerge
+    \brief Merge strategy when BAM files are unsorted, or their sorted status is either unknown or ignored
 */
 /*! \var BamMultiReader::MergeOrder BamMultiReader::MergeByCoordinate
-    \brief The description of the first enum value.
+    \brief Merge strategy when BAM files are sorted by position ('coordinate')
 */
 /*! \var BamMultiReader::MergeOrder BamMultiReader::MergeByName
-    \brief BAM files are
+    \brief Merge strategy when BAM files are sorted by read name ('queryname')
 */
 
-
-
 /*! \fn BamMultiReader::BamMultiReader(void)
     \brief constructor
 */
@@ -365,10 +368,11 @@ bool BamMultiReader::Rewind(void) {
     nothing in the API to prevent you from doing so, but the results may be
     unexpected.
 
+    \returns \c true if merge order could be successfully applied
     \sa BamMultiReader::MergeOrder, GetMergeOrder(), GetNextAlignment(), GetNextAlignmentCore()
 */
-void BamMultiReader::SetExplicitMergeOrder(BamMultiReader::MergeOrder order) {
-    d->SetExplicitMergeOrder(order);
+bool BamMultiReader::SetExplicitMergeOrder(BamMultiReader::MergeOrder order) {
+    return d->SetExplicitMergeOrder(order);
 }
 
 /*! \fn bool BamMultiReader::SetRegion(const BamRegion& region)