Changeset 2884 for trunk/yat


Ignore:
Timestamp:
Dec 4, 2012, 3:17:22 AM (11 years ago)
Author:
Peter
Message:

add missing since tags. refs #729

Location:
trunk/yat/omic
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/yat/omic/BamFile.h

    r2883 r2884  
    3838  /**
    3939     Base class for bam files
     40
     41     \since New in yat 0.10
    4042   */
    4143  template<typename Derived>
    … …  
    9193  /**
    9294     This class supports reading from a bam file.
     95
     96     \since New in yat 0.10
    9397   */
    9498  class InBamFile : public BamFile<InBamFile>
    … …  
    158162  /**
    159163     This class supports writing to a bam file.
     164
     165     \since New in yat 0.10
    160166   */
    161167  class OutBamFile : public BamFile<OutBamFile>

  • trunk/yat/omic/BamHeader.h

    r2883 r2884  
    2929
    3030     Class is typically created within InBamFile
     31
     32     \since New in yat 0.10
    3133   */
    3234  class BamHeader

  • trunk/yat/omic/BamRead.h

    r2883 r2884  
    6767
    6868     \see samtools
     69
     70     \since New in yat 0.10
    6971   */
    7072  class BamRead
    … …  
    226228     \return \c true if read is soft clipped, either left_soft_clipped
    227229     or right_soft_clipped.
     230
     231     \since New in yat 0.10
    228232   */
    229233  bool soft_clipped(const BamRead& bam);
    … …  
    232236     If read is soft clipped on left side, return how many bases are
    233237     clipped, otherwise return 0.
     238
     239     \since New in yat 0.10
    234240   */
    235241  uint32_t left_soft_clipped(const BamRead& bam);
    … …  
    238244     If read is soft clipped on right side, return how many bases are
    239245     clipped, otherwise return 0.
     246
     247     \since New in yat 0.10
    240248   */
    241249  uint32_t right_soft_clipped(const BamRead& bam);
    … …  
    245253
    246254     \see BamRead::name()
     255
     256     \since New in yat 0.10
    247257   */
    248258  bool same_query_name(const BamRead& lhs, const BamRead& rhs);
    … …  
    253263
    254264     \see BamRead
     265
     266     \since New in yat 0.10
    255267   */
    256268  struct BamLessPos
    … …  
    272284
    273285     \see BamRead
     286
     287     \since New in yat 0.10
    274288   */
    275289  struct BamLessEnd

  • trunk/yat/omic/BamReadIterator.h

    r2883 r2884  
    5050
    5151     \see InBamFile
     52
     53     \since New in yat 0.10
    5254   */
    5355  class BamReadIterator

  • trunk/yat/omic/BamWriteIterator.h

    r2883 r2884  
    3232  /**
    3333     Functor taking a BamRead and writing to an OutBamFile
     34
     35     \since New in yat 0.10
    3436   */
    3537  class BamWriter : std::unary_function<const BamRead&, void>
    … …  
    7375     \see OutBamFile
    7476     \see std::ostream_iterator
     77
     78     \since New in yat 0.10
    7579   */
    7680  class BamWriteIterator
Note: See TracChangeset for help on using the changeset viewer.