documented that wxHSCROLL disables wrapping; added comment to the source

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

diff --git a/docs/latex/wx/wave.tex b/docs/latex/wx/wave.tex
index b694ab7cadb094422a11343d1ca3ad602c0a2ac5..208ebcf7c8405c0ecef06198e86309ad7faf2ec0 100644 (file)
--- a/docs/latex/wx/wave.tex
+++ b/docs/latex/wx/wave.tex
@@ -1,13 +1,17 @@
 \section{\class{wxWave}}\label{wxwave}
 
 This class represents a short wave file, in Windows WAV format, that
-can be stored in memory and played. Currently this class is for Windows
-only.
+can be stored in memory and played. Currently this class is implemented
+on Windows and Linux only.
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/wave.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxWave::wxWave}\label{wxwaveconstr}
@@ -16,7 +20,7 @@ only.
 
 Default constructor.
 
-\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
+\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
 
 Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
 determine whether this succeeded.
@@ -25,7 +29,7 @@ determine whether this succeeded.
 
 \docparam{fileName}{The filename or Windows resource.}
 
-\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
+\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}
 
 \membersection{wxWave::\destruct{wxWave}}
 
@@ -35,7 +39,7 @@ Destroys the wxWave object.
 
 \membersection{wxWave::Create}\label{wxwavecreate}
 
-\func{bool}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
+\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
 
 Constructs a wave object from a file or resource.
 
@@ -43,21 +47,21 @@ Constructs a wave object from a file or resource.
 
 \docparam{fileName}{The filename or Windows resource.}
 
-\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
+\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}
 
 \wxheading{Return value}
 
-TRUE if the call was successful, FALSE otherwise.
+true if the call was successful, false otherwise.
 
 \membersection{wxWave::IsOk}\label{wxwaveisok}
 
 \constfunc{bool}{IsOk}{\void}
 
-Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.
+Returns true if the object contains a successfully loaded file or resource, false otherwise.
 
 \membersection{wxWave::Play}\label{wxwaveplay}
 
-\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}
+\constfunc{bool}{Play}{\param{bool}{ async = true}, \param{bool}{ looped = false}}
 
 Plays the wave file synchronously or asynchronously, looped or single-shot.