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: archive.h
// Purpose: documentation for wxArchiveInputStream class
// Purpose: interface of wxArchiveInputStream
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -23,8 +23,7 @@
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
@see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
wxArchiveOutputStream
*/
class wxArchiveInputStream : public wxFilterInputStream
@@ -55,6 +54,7 @@ public:
};
/**
@class wxArchiveOutputStream
@wxheader{archive.h}
@@ -70,8 +70,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
@see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry,
wxArchiveInputStream
*/
class wxArchiveOutputStream : public wxFilterOutputStream
@@ -151,6 +150,7 @@ public:
};
/**
@class wxArchiveEntry
@wxheader{archive.h}
@@ -163,9 +163,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
"Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
@see @ref overview_wxarc "Archive formats such as zip", @ref
overview_wxarcgeneric "Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier
*/
class wxArchiveEntry : public wxObject
{
@@ -250,7 +249,7 @@ public:
//@{
/**
Sets the notifier for this entry.
Sets the notifier() for this entry.
Whenever the wxArchiveInputStream updates
this entry, it will then invoke the associated
notifier's wxArchiveNotifier::OnEntryUpdated
@@ -265,6 +264,7 @@ public:
};
/**
@class wxArchiveClassFactory
@wxheader{archive.h}
@@ -289,9 +289,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
"Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory
@see @ref overview_wxarc "Archive formats such as zip", @ref
overview_wxarcgeneric "Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory
*/
class wxArchiveClassFactory : public wxObject
{
@@ -401,6 +400,7 @@ public:
};
/**
@class wxArchiveNotifier
@wxheader{archive.h}
@@ -423,9 +423,8 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
@ref overview_wxarcnoseek "Archives on non-seekable streams", wxArchiveEntry,
wxArchiveInputStream, wxArchiveOutputStream
@see @ref overview_wxarcnoseek "Archives on non-seekable streams",
wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
*/
class wxArchiveNotifier
{
@@ -437,6 +436,7 @@ public:
};
/**
@class wxArchiveIterator
@wxheader{archive.h}
@@ -535,8 +535,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
@see wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream
*/
class wxArchiveIterator
{
@@ -564,3 +563,4 @@ public:
wxArchiveIterator operator++(int );
//@}
};