From 47c940e2a59c6796e4d8ea2dbed19881fdae1102 Mon Sep 17 00:00:00 2001 From: Derek Barnett Date: Mon, 14 Jan 2013 20:41:23 -0500 Subject: [PATCH] Updated MergeOrder enum documentation --- src/api/BamMultiReader.cpp | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/api/BamMultiReader.cpp b/src/api/BamMultiReader.cpp index 57c826d..9e8920a 100644 --- 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 */ -- 2.39.2