regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of'

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-10 15:24:38 +00:00
parent 3a65144e7c
commit e54c96f187
269 changed files with 2027 additions and 1553 deletions

View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: zipstrm.h
// Purpose: documentation for wxZipNotifier class
// Purpose: interface of wxZipNotifier
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -25,8 +25,7 @@
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry,
@see @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry,
wxZipInputStream, wxZipOutputStream
*/
class wxZipNotifier
@@ -40,6 +39,7 @@ public:
};
/**
@class wxZipEntry
@wxheader{zipstrm.h}
@@ -49,8 +49,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", wxZipInputStream,
@see @ref overview_wxarc "Archive formats such as zip", wxZipInputStream,
wxZipOutputStream, wxZipNotifier
*/
class wxZipEntry : public wxArchiveEntry
@@ -204,7 +203,7 @@ public:
//@{
/**
Sets the notifier for this entry.
Sets the notifier() for this entry.
Whenever the wxZipInputStream updates
this entry, it will then invoke the associated
notifier's wxZipNotifier::OnEntryUpdated
@@ -226,6 +225,7 @@ public:
};
/**
@class wxZipInputStream
@wxheader{zipstrm.h}
@@ -245,8 +245,8 @@ public:
@library{wxbase}
@category{streams}
@seealso
@ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipOutputStream
@see @ref overview_wxarc "Archive formats such as zip", wxZipEntry,
wxZipOutputStream
*/
class wxZipInputStream : public wxArchiveInputStream
{
@@ -305,6 +305,7 @@ public:
};
/**
@class wxZipClassFactory
@wxheader{zipstrm.h}
@@ -315,9 +316,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
"Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream
@see @ref overview_wxarc "Archive formats such as zip", @ref
overview_wxarcgeneric "Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream
*/
class wxZipClassFactory : public wxArchiveClassFactory
{
@@ -326,6 +326,7 @@ public:
};
/**
@class wxZipOutputStream
@wxheader{zipstrm.h}
@@ -340,8 +341,8 @@ public:
@library{wxbase}
@category{streams}
@seealso
@ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipInputStream
@see @ref overview_wxarc "Archive formats such as zip", wxZipEntry,
wxZipInputStream
*/
class wxZipOutputStream : public wxArchiveOutputStream
{
@@ -438,3 +439,4 @@ public:
*/
void SetComment(const wxString& comment);
};