Updated Doxygen comments

[bamtools.git] / src / api / BamReader.h

diff --git a/src/api/BamReader.h b/src/api/BamReader.h
index 836fbf5e3cbac860f62916c3e717c72618089a7b..8e15a5c4abdb0e68804a035e1d3a116059c59ae0 100644 (file)
--- a/src/api/BamReader.h
+++ b/src/api/BamReader.h
@@ -2,7 +2,7 @@
 // BamReader.h (c) 2009 Derek Barnett, Michael Str�mberg\r
 // Marth Lab, Department of Biology, Boston College\r
 // ---------------------------------------------------------------------------\r
-// Last modified: 4 March 2011 (DB)\r
+// Last modified: 7 October 2011 (DB)\r
 // ---------------------------------------------------------------------------\r
 // Provides read access to BAM files.\r
 // ***************************************************************************\r
@@ -37,7 +37,7 @@ class API_EXPORT BamReader {
         // ----------------------\r
 \r
         // closes the current BAM file\r
-        void Close(void);\r
+        bool Close(void);\r
         // returns filename of current BAM file\r
         const std::string GetFilename(void) const;\r
         // returns true if a BAM file is open for reading\r
@@ -102,10 +102,12 @@ class API_EXPORT BamReader {
         // changes the caching behavior of the index data\r
         void SetIndexCacheMode(const BamIndex::IndexCacheMode& mode);\r
 \r
-    // deprecated methods\r
-    public:\r
-        // returns true if index data is available\r
-        bool IsIndexLoaded(void) const;\r
+        // ----------------------\r
+        // error handling\r
+        // ----------------------\r
+\r
+        // returns a human-readable description of the last error that occurred\r
+        std::string GetErrorString(void) const;\r
         \r
     // private implementation\r
     private:\r