Mercurial > code
view modules/zip/doc/mainpage.cpp @ 548:f48bb09bccc7
Misc: huge cleanup, switch to spaces
author | David Demelier <markand@malikania.fr> |
---|---|
date | Wed, 15 Jun 2016 13:13:26 +0200 |
parents | 8f8c32f102f1 |
children |
line wrap: on
line source
/** * \mainpage * * Welcome to the zip library. * * ## Introduction * * The libzip library is a good C library for opening and creating zip archives, this wrapper provides safe C++ classes * around this great library. * * The benefits: * * - Automatic allocations and destructions (RAII), * - Easy way to add files, * - Easy API, * - Easy file reading in archive, * - Convenience, thanks to C++ function overloads. * * * ## Requirements * * - [libzip](http://www.nih.at/libzip), * - C++11. * * ## Installation * * Just copy the file zippy.hpp and add it to your project. * * ## Overview * * Very simple extraction of a file. * * ````cpp * #include <iostream> * * #include "zippy.hpp" * * try { * zippy::Archive archive("mydata.zip"); * zippy::Stat stat = archive.stat("README"); * zippy::File file = archive.open("README"); * * std::cout << "content of README:" << std::endl; * std::cout << file.read(stat.size); * } catch (const std::exception &ex) { * std::cerr << ex.what() << std::endl; * } * ```` */