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: stream.h
// Purpose: documentation for wxCountingOutputStream class
// Purpose: interface of wxCountingOutputStream
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -49,6 +49,7 @@ public:
};
/**
@class wxBufferedInputStream
@wxheader{stream.h}
@@ -62,8 +63,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxStreamBuffer, wxInputStream, wxBufferedOutputStream
@see wxStreamBuffer, wxInputStream, wxBufferedOutputStream
*/
class wxBufferedInputStream : public wxFilterInputStream
{
@@ -72,6 +72,7 @@ public:
};
/**
@class wxStreamBuffer
@wxheader{stream.h}
@@ -80,8 +81,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxStreamBase
@see wxStreamBase
*/
class wxStreamBuffer
{
@@ -278,6 +278,7 @@ public:
};
/**
@class wxOutputStream
@wxheader{stream.h}
@@ -352,6 +353,7 @@ public:
};
/**
@class wxFilterClassFactory
@wxheader{stream.h}
@@ -376,8 +378,7 @@ public:
@library{wxbase}
@category{FIXME}
@seealso
wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref
@see wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref
overview_wxarc "Archive formats such as zip"
*/
class wxFilterClassFactory : public wxObject
@@ -471,6 +472,7 @@ public:
};
/**
@class wxFilterOutputStream
@wxheader{stream.h}
@@ -483,8 +485,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxFilterClassFactory, wxFilterInputStream
@see wxFilterClassFactory, wxFilterInputStream
*/
class wxFilterOutputStream : public wxOutputStream
{
@@ -501,6 +502,7 @@ public:
};
/**
@class wxFilterInputStream
@wxheader{stream.h}
@@ -514,8 +516,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxFilterClassFactory, wxFilterOutputStream
@see wxFilterClassFactory, wxFilterOutputStream
*/
class wxFilterInputStream : public wxInputStream
{
@@ -532,6 +533,7 @@ public:
};
/**
@class wxBufferedOutputStream
@wxheader{stream.h}
@@ -547,8 +549,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxStreamBuffer, wxOutputStream
@see wxStreamBuffer, wxOutputStream
*/
class wxBufferedOutputStream : public wxFilterOutputStream
{
@@ -577,6 +578,7 @@ public:
};
/**
@class wxInputStream
@wxheader{stream.h}
@@ -670,6 +672,7 @@ public:
};
/**
@class wxStreamBase
@wxheader{stream.h}
@@ -681,8 +684,7 @@ public:
@library{wxbase}
@category{streams}
@seealso
wxStreamBuffer
@see wxStreamBuffer
*/
class wxStreamBase
{
@@ -722,7 +724,8 @@ public:
Returns the length of the stream in bytes. If the length cannot be determined
(this is always the case for socket streams for example), returns
@c wxInvalidOffset.
This function is new since wxWidgets version 2.5.4
@wxsince{2.5.4}
*/
wxFileOffset GetLength() const;
@@ -768,3 +771,4 @@ public:
*/
size_t OnSysWrite(const void* buffer, size_t bufsize);
};