]> git.donarmstrong.com Git - bamtools.git/blobdiff - src/api/BamAlgorithms.h
Updated Doxygen comments
[bamtools.git] / src / api / BamAlgorithms.h
index 8a8e16bb9bdb9220a8364c0e98fa0958b072ca9b..9493c7fd5a1987f5e2c5715da2e2c5493bc7d6b9 100644 (file)
@@ -3,7 +3,7 @@
 // Marth Lab, Department of Biology, Boston College
 // All rights reserved.
 // ---------------------------------------------------------------------------
-// Last modified: 29 September 2011 (DB)
+// Last modified: 10 October 2011 (DB)
 // ---------------------------------------------------------------------------
 // Provides generic algorithms that are intended to work with BamTools data
 // structures. Where possible, these are intended to be STL-compatible.
@@ -14,5 +14,8 @@
 
 #include <api/algorithms/Sort.h>
 
+/*! \namespace BamTools::Algorithms
+    \brief Provides convenient classes & methods for working with BAM data
+*/
 
 #endif // BAM_ALGORITHMS_H