Changeset 3158

Timestamp:

Jan 9, 2014, 2:37:24 AM (9 years ago)

Author:

Peter

Message:

improve docs for BamHeader?

File:

• branches/0.11-stable/yat/omic/BamHeader.h (modified) (2 diffs)

branches/0.11-stable/yat/omic/BamHeader.h

@@ -34 +34 @@
 
   /**
-     Wrapper around bam_header_t struct.
+     \brief Wrapper around bam_header_t struct.
 
-     Class is typically created within InBamFile
+     Class is typically created via InBamFile::header().
+
+     It is possible to copy and assign a BamHeader, but note that a
+     BamHeader does not own underlying data. The underlying data is
+     owned by the InBamFile and the BamHeader is thus invalid after
+     the corresponding InBamFile has been destroyed.
 
      \since New in yat 0.10
@@ -77 +82 @@
        \brief inverse of target_name(size_t)
 
-       \note If \a name does not exist, behaviour is unexpected.
+       \note If \a name does not exist, behaviour is undefined.
 
        \since new in yat 0.11