Changeset 2896


Ignore:
Timestamp:
Dec 10, 2012, 10:52:30 PM (9 years ago)
Author:
Peter
Message:

improve doc and remove private classes from docs

File:
1 edited

Legend:

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

    r2884 r2896  
    8080       InBamFile::index().
    8181
     82       All reads iterated over overlap with defined region, in other
     83       words, iter->tid == \a tid; iter->pos() < \a end and iter->end()
     84       > start
     85
    8286       \param in file to iterate over
    8387       \param tid segment (chromosome) to iterate over
     
    9296    void increment(void);
    9397
    94     /**
     98    /*
    9599       Interface class for the actor that handles difference between
    96100       an iterator that iterates the entire file and one that uses
     
    107111    };
    108112
    109     /// class used when region is entire file
     113    // class used when region is entire file
    110114    class AllActor : public Actor
    111115    {
     
    116120    };
    117121
    118     /// class used when iterating over a sub-region of the bam file
     122    // class used when iterating over a sub-region of the bam file
    119123    class IndexActor : public Actor
    120124    {
Note: See TracChangeset for help on using the changeset viewer.