X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a83f860948059b0273b5cc6d9e43fadad3ebfca..ba49d2acf95d53517719c4fd9ac2ad5aaa13540b:/docs/doxygen/overviews/archive.h diff --git a/docs/doxygen/overviews/archive.h b/docs/doxygen/overviews/archive.h index 95e1782fc5..f789ff78cf 100644 --- a/docs/doxygen/overviews/archive.h +++ b/docs/doxygen/overviews/archive.h @@ -3,15 +3,17 @@ // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @page overview_archive Archive Formats +@tableofcontents + The archive classes handle archive formats such as zip, tar, rar and cab. -Currently wxZip and wxTar classes are included. +Currently wxZip, wxTar and wxZlib classes are included. For each archive type, there are the following classes (using zip here as an example): @@ -30,17 +32,6 @@ The classes are designed to handle archives on both seekable streams such as disk files, or non-seekable streams such as pipes and sockets (see @ref overview_archive_noseek). -See also wxFileSystem. - -@li @ref overview_archive_create -@li @ref overview_archive_extract -@li @ref overview_archive_modify -@li @ref overview_archive_byname -@li @ref overview_archive_generic -@li @ref overview_archive_noseek - - -
@section overview_archive_create Creating an Archive @@ -361,7 +352,7 @@ attempts to update it if it is still around. The documentation for each archive entry type gives the details of what meta-data becomes available and when. For generic programming, when the worst case must be assumed, you can rely on all the fields of wxArchiveEntry being -fully populated when GetNextEntry() returns, with the the following exceptions: +fully populated when GetNextEntry() returns, with the following exceptions: @li wxArchiveEntry::GetSize(): Guaranteed to be available after the entry has been read to wxInputStream::Eof(), or wxArchiveInputStream::CloseEntry()