seqan/seqan — pull request #764 by esiragusa (2014-12-18 11:26:32+00:00)
Title: Updated I/O dox

See #680.

Done:
* Introduced dox-only concepts FormattedFileConcept, FormattedFileInConcept, FormattedFileOutConcept.
* Updated SmartFile dox.
* Updated BamFileIn/BamFileOut dox.

Todo:
* Document the other file formats (as soon as you review this PR).
* Document low-level I/O (e.g. VirtualStream)
* Make all read/writeRecord(record, context, iter, format) functions private as they are misleading (@weese is there a need for this lower layer?)
* Rename the SmartFile class as FormattedFile, as the name SmartFile is misleading (@weese do you agree?)
* Improve the dox for concepts (see #763).

I assign @rrahn but also @holtgrewe might want to have a look.