Updated documentation

pull/339/head
Jeffrey Walton 2016-11-19 04:40:07 -05:00
parent cb7dbd32ec
commit 3fc97d2bff
No known key found for this signature in database
GPG Key ID: B36AB348921B1838
1 changed files with 3 additions and 3 deletions

View File

@ -84,18 +84,18 @@ public:
typedef FileStore::OpenErr OpenErr;
typedef FileStore::ReadErr ReadErr;
//! \brief Construct a FileStore
//! \brief Construct a FileSource
FileSource(BufferedTransformation *attachment = NULL)
: SourceTemplate<FileStore>(attachment) {}
//! \brief Construct a FileStore
//! \brief Construct a FileSource
//! \param in an existing stream
//! \param pumpAll flag indicating if source data should be pumped to its attached transformation
//! \param attachment an optional attached transformation
FileSource(std::istream &in, bool pumpAll, BufferedTransformation *attachment = NULL)
: SourceTemplate<FileStore>(attachment) {SourceInitialize(pumpAll, MakeParameters(Name::InputStreamPointer(), &in));}
//! \brief Construct a FileStore
//! \brief Construct a FileSource
//! \param filename the narrow name of the file to open
//! \param pumpAll flag indicating if source data should be pumped to its attached transformation
//! \param attachment an optional attached transformation