reformat stream overview and provide a description hopefully correct, even if very short, for wxStreamBuffer

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57332 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-12-14 14:51:42 +00:00
parent 3d46a376b1
commit eb63011d3f
3 changed files with 37 additions and 25 deletions

View File

@@ -99,12 +99,16 @@ public:
/**
@class wxStreamBuffer
@todo WRITE A DESCRIPTION
wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer
linked to a stream.
Each stream always has one autoinitialized stream buffer, but you may
attach more of them to the same stream.
@library{wxbase}
@category{streams}
@see wxStreamBase
@see wxStreamBase, @ref overview_stream
*/
class wxStreamBuffer
{
@@ -127,7 +131,9 @@ public:
@code
streambuffer.Read(...);
streambuffer2.Read(...); // This call erases previous error messages set by 'streambuffer'
streambuffer2.Read(...);
// This call erases previous error messages set by 'streambuffer'
// assuming that both instances are stream buffers for the same stream
@endcode
@see SetBufferIO()