do not use @b when referencing to functions; use final () to enable doxygen autolink

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

diff --git a/interface/wx/stream.h b/interface/wx/stream.h
index 2524ef912049daf64ca4407d0e1dad0c2fdd1723..0d7511ce4439cfcfbf951cf53400f5c3c3a925c7 100644 (file)
--- a/interface/wx/stream.h
+++ b/interface/wx/stream.h
@@ -99,12 +99,16 @@ public:
 /**
     @class wxStreamBuffer
 
 /**
     @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}
 
 
     @library{wxbase}
     @category{streams}
 

-    @see wxStreamBase
+    @see wxStreamBase, @ref overview_stream

 */
 class wxStreamBuffer
 {
 */
 class wxStreamBuffer
 {


@@ -127,7 +131,9 @@ public:
 
         @code
         streambuffer.Read(...);
 
         @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()
         @endcode
 
         @see SetBufferIO()