Added periods

[wxWidgets.git] / docs / latex / wx / stream.tex

diff --git a/docs/latex/wx/stream.tex b/docs/latex/wx/stream.tex
index c48821a94f71950df0bd7e56745e2e9b19bffc7b..90cd8c8840dcf98c3ee991ca0928156894bdae43 100644 (file)
--- a/docs/latex/wx/stream.tex
+++ b/docs/latex/wx/stream.tex
@@ -8,6 +8,10 @@ None
 
 <wx/stream.h>
 
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxStreamBase}{wxstreambase}
@@ -95,8 +99,8 @@ It returns the size of the data read. If the returned size is different of the s
 
 \func{size\_t}{Read}{\param{wxStreamBuffer *}{buffer}}
 
-Reads a {\it buffer}. The function returns when {\it buffer} is full or when there isn't
-data anymore in the current buffer.
+Copies data to {\it buffer}. The function returns when {\it buffer} is full or when there isn't
+any more data in the current buffer.
 
 \wxheading{See also}
 
@@ -184,6 +188,17 @@ the beginning of the stream. Otherwise, it returns wxInvalidOffset.
 
 Resets to the initial state variables concerning the buffer.
 
+
+\membersection{wxStreamBuffer::Truncate}\label{wxstreambuffertruncate}
+
+\func{void}{Truncate}{\void}
+
+Truncates the buffer to the current position.
+
+Note: Truncate() cannot be used to enlarge the buffer. This is
+usually not needed since the buffer expands automatically.
+
+
 \membersection{wxStreamBuffer::SetBufferIO}\label{wxstreambuffersetbufferio}
 
 \func{void}{SetBufferIO}{\param{char*}{ buffer\_start}, \param{char*}{ buffer\_end}}
@@ -226,19 +241,19 @@ The created IO buffer is growable by the object.
 
 \membersection{wxStreamBuffer::GetBufferStart}\label{wxstreambuffergetbufferstart}
 
-\constfunc{char *}{GetBufferStart}{\void}
+\constfunc{void *}{GetBufferStart}{\void}
 
 Returns a pointer on the start of the stream buffer.
 
 \membersection{wxStreamBuffer::GetBufferEnd}\label{wxstreambuffergetbufferend}
 
-\constfunc{char *}{GetBufferEnd}{\void}
+\constfunc{void *}{GetBufferEnd}{\void}
 
 Returns a pointer on the end of the stream buffer.
 
 \membersection{wxStreamBuffer::GetBufferPos}\label{wxstreambuffergetbufferpos}
 
-\constfunc{char *}{GetBufferPos}{\void}
+\constfunc{void *}{GetBufferPos}{\void}
 
 Returns a pointer on the current position of the stream buffer.
 
@@ -296,6 +311,12 @@ Flushes the IO buffer.
 
 Fill the IO buffer.
 
+\membersection{wxStreamBuffer::GetBufferSize}\label{wxstreambuffergetbuffersize}
+
+\constfunc{size\_t}{GetBufferSize}{\void}
+
+Returns the size of the buffer.
+
 \membersection{wxStreamBuffer::GetDataLeft}\label{wxstreambuffergetdataleft}
 
 \func{size\_t}{GetDataLeft}{\void}