added a @todo about references to old wx functions

[wxWidgets.git] / interface / wx / archive.h

diff --git a/interface/wx/archive.h b/interface/wx/archive.h
index cb2069dc6057b9d10042def7503499b759776014..c95f875776c708058d70760bbce089b090bd4bcc 100644 (file)
--- a/interface/wx/archive.h
+++ b/interface/wx/archive.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxArchiveInputStream
-    @wxheader{archive.h}
 
     This is an abstract base class which serves as a common interface to
     archive input streams such as wxZipInputStream.
@@ -23,7 +22,7 @@
     When there are no more entries, GetNextEntry() returns @NULL and sets Eof().
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see @ref overview_archive, wxArchiveEntry, wxArchiveOutputStream
 */
@@ -57,7 +56,6 @@ public:
 
 /**
     @class wxArchiveOutputStream
-    @wxheader{archive.h}
 
     This is an abstract base class which serves as a common interface to
     archive output streams such as wxZipOutputStream.
@@ -67,7 +65,7 @@ public:
     Another call to PutNextEntry() closes the current entry and begins the next.
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see @ref overview_archive, wxArchiveEntry, wxArchiveInputStream
 */
@@ -158,14 +156,13 @@ public:
 
 /**
     @class wxArchiveEntry
-    @wxheader{archive.h}
 
     This is an abstract base class which serves as a common interface to
     archive entry classes such as wxZipEntry.
     These hold the meta-data (filename, timestamp, etc.), for entries
     in archive files such as zips and tars.
 
-    @section wxarchiveentry_nonseekable About non-seekable streams
+    @section archiveentry_nonseekable About non-seekable streams
 
     This information applies only when reading archives from non-seekable streams.
     When the stream is seekable GetNextEntry() returns a fully populated wxArchiveEntry.
@@ -181,7 +178,7 @@ public:
         been reached, i.e. after GetNextEntry() returns NULL and Eof() is true.
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see @ref overview_archive, @ref overview_archive_generic,
          wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
@@ -316,7 +313,6 @@ enum wxStreamProtocolType
 
 /**
     @class wxArchiveClassFactory
-    @wxheader{archive.h}
 
     Allows the creation of streams to handle archive formats such as zip and tar.
 
@@ -336,7 +332,7 @@ enum wxStreamProtocolType
     wxArchiveClassFactory::GetFirst() and wxArchiveClassFactory::GetNext().
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see @ref overview_archive, @ref overview_archive_generic, wxArchiveEntry,
          wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory
@@ -476,7 +472,6 @@ public:
 
 /**
     @class wxArchiveNotifier
-    @wxheader{archive.h}
 
     If you need to know when a wxArchiveInputStream updates a wxArchiveEntry
     object, you can create a notifier by deriving from this abstract base class,
@@ -493,7 +488,7 @@ public:
     See @ref overview_archive_noseek.
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see @ref overview_archive_noseek, wxArchiveEntry, wxArchiveInputStream,
          wxArchiveOutputStream
@@ -511,7 +506,6 @@ public:
 
 /**
     @class wxArchiveIterator
-    @wxheader{archive.h}
 
     An input iterator template class that can be used to transfer an archive's
     catalogue to a container. It is only available if wxUSE_STL is set to 1
@@ -519,7 +513,7 @@ public:
     supports member templates.
 
     @code
-    template class Arc, class T = typename Arc::entry_type*
+    template<class Arc, class T = typename Arc::entry_type*>
     class wxArchiveIterator
     {
         // this constructor creates an 'end of sequence' object
@@ -534,8 +528,8 @@ public:
 
     The first template parameter should be the type of archive input stream
     (e.g. wxArchiveInputStream) and the second can either be a pointer to an entry
-    (e.g. wxArchiveEntry*), or a string/pointer pair (e.g. std::pairwxString,
-    wxArchiveEntry*).
+    (e.g. wxArchiveEntry*), or a string/pointer pair
+    (e.g. std::pair<wxString,wxArchiveEntry*>).
 
     The @c wx/archive.h header defines the following typedefs:
 
@@ -603,7 +597,7 @@ public:
     @endcode
 
     @library{wxbase}
-    @category{archive}
+    @category{archive,streams}
 
     @see wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
 */