PROG: Fixed FileList documentation References #4807 (841751a9) · Commits · aflab / astrogeology / ISIS3

isis/src/base/objs/FileList/FileList.cpp

+5 −12

Original line number	Diff line number	Diff line
		@@ -38,28 +38,21 @@ namespace Isis {
		FileList::FileList() {
		}


		/**
		* Constructs a FileList from a stream.
		* Constructs a FileList from a FileName.
		*
		* @param in An input stream containing a list of files.
		* @param listFile A FileName obj
		*/
		FileList::FileList(FileName listFile) {
		read(listFile);
		}

		/**
		* Constructs a FileList from a stream.
		*
		* @param path of a file containing a list of files.
		*/
		/*FileList::FileList(IString listFileString) {
		read(FileName(listFileString));
		}*/

		/**
		* Opens and loads the list of files from a file.
		*
		* @param list Name of the file to open that contains the list of files.
		* @param listFile Name of the file to open that contains the list of files.
		*
		* @throws Isis::iException::Io - Cannot open file
		*/
		@@ -165,7 +158,7 @@ namespace Isis {
		/**
		* Writes a list of files to a file.
		*
		* @param list The name of the file to create. The method will overwrite any
		* @param outputFileList The name of the file to create. The method will overwrite any
		* existing files.
		*
		* @throws Isis::iException::Io File could not be created.

+12 −2

Original line number	Diff line number	Diff line
		@@ -65,21 +65,31 @@ namespace Isis {
		* as a 'end of line' signal.
		* @history 2017-08-15 Adam Goins - removed a printf() that resulted in
		* extraneous output to be displayed. Ref#5112
		* @history 2017-09-22 Cole Neubauer - Fixed documentation. References #4708
		*/
		class FileList : public QList<FileName> {
		public:
		//FileList(QString listFileString);
		//! Creates a FileList based on a FileName
		FileList(FileName listFile);
		/**
		* Constructs a FileList from an istream.
		*
		* @param in the istream to read from
		*/
		FileList(std::istream &in);
		//! Creates an empty FileList obj
		FileList();

		//! Destroys the FileList object.
		~FileList() {};

		//! reads in a FileName obj
		void read(FileName listFile);
		//void read(const QString &list);
		//! reads in an istream
		void read(std::istream &in);
		//! writes to a FileName obj
		void write(FileName outputFileList);
		//! writes to an ostream
		void write(std::ostream &out);
		};
		};