Changeset 3158


Ignore:
Timestamp:
Jan 9, 2014, 2:37:24 AM (8 years ago)
Author:
Peter
Message:

improve docs for BamHeader?

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/0.11-stable/yat/omic/BamHeader.h

    r2999 r3158  
    3434
    3535  /**
    36      Wrapper around bam_header_t struct.
     36     \brief Wrapper around bam_header_t struct.
    3737
    38      Class is typically created within InBamFile
     38     Class is typically created via InBamFile::header().
     39
     40     It is possible to copy and assign a BamHeader, but note that a
     41     BamHeader does not own underlying data. The underlying data is
     42     owned by the InBamFile and the BamHeader is thus invalid after
     43     the corresponding InBamFile has been destroyed.
    3944
    4045     \since New in yat 0.10
     
    7782       \brief inverse of target_name(size_t)
    7883
    79        \note If \a name does not exist, behaviour is unexpected.
     84       \note If \a name does not exist, behaviour is undefined.
    8085
    8186       \since new in yat 0.11
Note: See TracChangeset for help on using the changeset viewer.