// Name: archive.h
// 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):
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
-
-
-<hr>
@section overview_archive_create Creating an Archive
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()