Changeset 2910


Ignore:
Timestamp:
Dec 17, 2012, 3:31:13 AM (9 years ago)
Author:
Peter
Message:

improve docs. closes #729

Location:
trunk/yat/omic
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/yat/omic/BamRead.h

    r2887 r2910  
    2222#include <bam.h>
    2323
     24#include <boost/move/move.hpp>
     25
    2426#include <functional>
    2527#include <string>
     
    284286  {
    285287    /**
    286        \return true if lhs tid is less than rhs tid; or if chromomes
     288       \return true if lhs tid is less than rhs tid; or tid
    287289       are equal and lhs pos is smaller than rhs pos.
    288290
    289        \see Bam::tid() Bam::pos()
     291       \see BamRead::tid() and BamRead::pos()
    290292     */
    291293    bool operator()(const BamRead& lhs, const BamRead& rhs) const;
     
    305307  {
    306308    /**
    307        \return true if lhs tid is less than rhs tid; or if chromomes
     309       \return true if lhs tid is less than rhs tid; or tid
    308310       are equal and lhs end is smaller than rhs end.
    309311
    310        \see Bam::tid() Bam::pos()
     312       \see BamRead::tid() and BamRead::end()
    311313     */
    312314    bool operator()(const BamRead& lhs, const BamRead& rhs) const;
  • trunk/yat/omic/BamWriteIterator.h

    r2884 r2910  
    3131
    3232  /**
    33      Functor taking a BamRead and writing to an OutBamFile
     33     Functor taking a BamRead and writing to an OutBamFile. Class is
     34     primarily used by BamWriteIterator.
    3435
    3536     \since New in yat 0.10
     
    7374     right hand side to associated OutBamFile.
    7475
    75      \see OutBamFile
    76      \see std::ostream_iterator
     76     \see OutBamFile and
     77     <a href="http://www.sgi.com/tech/stl/ostream_iterator.html">
     78     std::ostream_iterator</a>
    7779
    7880     \since New in yat 0.10
Note: See TracChangeset for help on using the changeset viewer.