Small updates in the documentation about threads.

Documentation about wxDataStream added.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@191 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index d7b446e48cdc60e49a1a9b12d584686d2411c29b..67c963df020acfc1814bc2c7f70d22e9d0ab0a19 100644 (file)
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -50,6 +50,7 @@ $$\image{14cm;0cm}{wxclass.ps}$$
 \input cursor.tex
 \input database.tex
 \input date.tex
 \input cursor.tex
 \input database.tex
 \input date.tex

+\input datstream.tex

 \input dc.tex
 \input ddeclint.tex
 \input ddeconn.tex
 \input dc.tex
 \input ddeclint.tex
 \input ddeconn.tex

diff --git a/docs/latex/wx/datstrm.tex b/docs/latex/wx/datstrm.tex
new file mode 100644 (file)
index 0000000..6954199
--- /dev/null
+++ b/docs/latex/wx/datstrm.tex
@@ -0,0 +1,109 @@
+\section{\class{wxDataStream}}\label{wxdatastream}
+
+This class provides functions that read and write integers or double in a
+portable way. So, a file written by an Intel processor can be read by a
+Sparc or anything else.
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxDataStream::wxDataStream}\label{wxwaveconstr}
+
+\func{}{wxDataStream}{\param{istream\&}{ stream}}
+
+Constructs a datastream object from a C++ input stream. Only read methods will
+be available.
+
+\wxheading{Parameters}
+
+\docparam{stream}{The C++ input stream.}
+
+\func{}{wxDataStream}{\param{istream\&}{ stream}}
+
+Constructs a datastream object from a C++ input stream. Only read methods will
+be available.
+
+\wxheading{Parameters}
+
+\docparam{stream}{The C++ input stream.}
+
+\membersection{wxDataStream::\destruct{wxDataStream}}
+
+\func{}{\destruct{wxDataStream}}{\void}
+
+Destroys the wxDataStream object.
+
+\membersection{wxDataStream::Read8}
+
+\func{unsigned char}{Read8}{\void}
+
+Reads a single byte from the stream.
+
+\membersection{wxDataStream::Read16}
+
+\func{unsigned short}{Read16}{\void}
+
+Reads a 16 bit integer from the stream.
+
+\membersection{wxDataStream::Read32}
+
+\func{unsigned long}{Read32}{\void}
+
+Reads a 32 bit integer from the stream.
+
+\membersection{wxDataStream::ReadDouble}
+
+\func{double}{ReadDouble}{\void}
+
+Reads a double (IEEE encoded) from the stream.
+
+\membersection{wxDataStream::ReadString}
+
+\func{wxString}{wxDataStream::ReadString}{\void}
+
+Reads a string from a stream. Actually, this function first reads a byte
+specifying the length of the string (without the last null character) and then
+reads the string.
+
+\membersection{wxDataStream::ReadLine}
+
+\func{wxString}{wxDataStream::ReadLine}{\void}
+
+Reads a line from the stream. A line is a string which ends with \\n or \\r\\n.
+
+\membersection{wxDataStream::Write8}
+
+\func{void}{wxDataStream::Write8}{{\param unsigned char }{i8}}
+
+Writes the single byte {\it i8} to the stream.
+
+\membersection{wxDataStream::Write16}
+
+\func{void}{wxDataStream::Write16}{{\param unsigned short }{i16}}
+
+Writes the 16 bit integer {\it i16} to the stream.
+
+\membersection{wxDataStream::Write32}
+
+\func{void}{wxDataStream::Write32}{{\param unsigned long }{i32}}
+
+Writes the 32 bit integer {\it i32} to the stream.
+
+\membersection{wxDataStream::WriteDouble}
+
+\func{void}{wxDataStream::WriteDouble}{{\param double }{f}}
+
+Writes the double {\it f} to the stream using the IEEE format.
+
+\membersection{wxDataStream::WriteString}
+
+\func{void}{wxDataStream::WriteString}{{\param const wxString& }{string}}
+
+Writes {\it string} to the stream. Actually, this method writes the size of
+the string before writing {\it string} itself.
+
+\membersection{wxDataStream::WriteLine}
+
+\func{void}{wxDataStream::WriteLine}{{\param const wxString& }{string}}
+
+Writes {\it string} as a line. Depending on the operating system, it adds
+\\n or \\r\\n.

diff --git a/docs/latex/wx/thread.tex b/docs/latex/wx/thread.tex
index ece9287b6943e5ef6f991f0d3dee0be3415bd126..f3b2d4b2b3bd7fa2872f74d5a881095b7c57fe84 100644 (file)
--- a/docs/latex/wx/thread.tex
+++ b/docs/latex/wx/thread.tex
@@ -45,7 +45,8 @@ One of:
 
 \func{void}{DeferDestroy}{\param{bool}{ defer}}
 
 
 \func{void}{DeferDestroy}{\param{bool}{ defer}}
 

-If {\it defer} is TRUE, defers thread destruction.
+If {\it defer} is TRUE, defers thread destruction. This function affects the
+calling thread.

 
 \membersection{wxThread::Destroy}\label{wxthreaddestroy}
 
 
 \membersection{wxThread::Destroy}\label{wxthreaddestroy}