Cleaned up intra-API includes & moved version numbers to 2.0.0

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

diff --git a/src/api/BamIndex.h b/src/api/BamIndex.h
index b202e921ff9d13c56796469abef5550486241430..5e40d87eb517d4fbc8797e8f5d874eb520602f56 100644 (file)
--- a/src/api/BamIndex.h
+++ b/src/api/BamIndex.h
@@ -2,7 +2,7 @@
 // BamIndex.h (c) 2009 Derek Barnett
 // Marth Lab, Department of Biology, Boston College
 // ---------------------------------------------------------------------------
 // BamIndex.h (c) 2009 Derek Barnett
 // Marth Lab, Department of Biology, Boston College
 // ---------------------------------------------------------------------------

-// Last modified: 6 October 2011 (DB)
+// Last modified: 10 October 2011 (DB)

 // ---------------------------------------------------------------------------
 // Provides basic BAM index interface
 // ***************************************************************************
 // ---------------------------------------------------------------------------
 // Provides basic BAM index interface
 // ***************************************************************************


@@ -10,8 +10,8 @@
 #ifndef BAM_INDEX_H
 #define BAM_INDEX_H
 
 #ifndef BAM_INDEX_H
 #define BAM_INDEX_H
 

-#include <api/api_global.h>
-#include <api/BamAux.h>
+#include "api/api_global.h"
+#include "api/BamAux.h"

 #include <string>
 
 namespace BamTools {
 #include <string>
 
 namespace BamTools {


@@ -29,8 +29,6 @@ namespace Internal {
 
     It is exposed to the public API to allow advanced users to implement
     their own custom indexing schemes.
 
     It is exposed to the public API to allow advanced users to implement
     their own custom indexing schemes.

-
-    More documentation on methods & enums coming soon.

 */
 
 class API_EXPORT BamIndex {
 */
 
 class API_EXPORT BamIndex {


@@ -76,16 +74,20 @@ class API_EXPORT BamIndex {
         // change the index caching behavior
         virtual void SetCacheMode(const BamIndex::IndexCacheMode& mode) =0;
 
         // change the index caching behavior
         virtual void SetCacheMode(const BamIndex::IndexCacheMode& mode) =0;
 

+    //! \cond
+

     // internal methods
     protected:
     // internal methods
     protected:

-        void SetErrorString(const std::string& where, const std::string& what) {
+        void SetErrorString(const std::string& where, const std::string& what) const {

             m_errorString = where + ": " + what;
         }
 
     // data members
     protected:
         Internal::BamReaderPrivate* m_reader; // copy, not owned
             m_errorString = where + ": " + what;
         }
 
     // data members
     protected:
         Internal::BamReaderPrivate* m_reader; // copy, not owned

-        std::string m_errorString;
+        mutable std::string m_errorString;
+
+    //! \endcond

 };
 
 } // namespace BamTools
 };
 
 } // namespace BamTools