00001 /* 00002 * bogus.h 00003 * 00004 * Unused header just for doxygen 00005 */ 00006 00007 /// \ingroup general 00008 /*@{*/ 00009 00010 //////////////////////////////////////////////////////////////////////////////// 00011 /// 00012 /// \defgroup gzstream Z-Lib Compatible Streaming Library 00013 /// 00014 /// The gzstream library provides objects that implement the std::stream 00015 /// interfaces (input/output) for gzip'd streams. 00016 /// 00017 /// This is very easy and effective to read/write gzip'd files, for instance. 00018 /// 00019 /// NOTE: this is unmodified gzstream code from 00020 /// http://www.cs.unc.edu/Research/compgeom/gzstream/ 00021 /// 00022 /// Many thanks to the gzstream authors for providing this code! 00023 /// 00024 /// The gzstream code is subject to the GNU Lesser General Public License. 00025 /// 00026 /// I have included the gzstream code in the wavepacket libraries because it 00027 /// is insanely useful but isn't otherwise generally distributed. 00028 /// 00029 //////////////////////////////////////////////////////////////////////////////// 00030 00031 /*@{*/ 00032 00033 /// \class igzstream 00034 /// \brief Input stream for reading from gzip'd data. 00035 /// Example Usage: 00036 /// \code 00037 /// igzstream in("my-file.txt.gz"); 00038 /// while (!in.eof()) { 00039 /// std::string line = in.getline(); 00040 /// std::cout << "I just read this line: " << line << "\n"; 00041 /// } 00042 /// \endcode 00043 00044 /// \class ogzstream 00045 /// \brief Output stream for writing gzip'd data. 00046 /// Example Usage: 00047 /// \code 00048 /// function(void) { 00049 /// ogzstream out("my-other-file.txt.gz"); 00050 /// out << "This is the first line of the gzip'd file.\n"; 00051 /// out << "This is the second and final line."; 00052 /// } 00053 /// \endcode
1.7.1