From 294e9a7aa00c23de9aad973b3998071b81159aee Mon Sep 17 00:00:00 2001 From: Guilhem Lavaux Date: Sat, 13 Mar 1999 20:14:37 +0000 Subject: [PATCH] * Docs fixes, wxStream overview enabled (all docs should compile now) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1922 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/clipbrd.tex | 4 ++-- docs/latex/wx/file.tex | 2 +- docs/latex/wx/ftp.tex | 4 ++-- docs/latex/wx/http.tex | 4 ++-- docs/latex/wx/inputstr.tex | 2 +- docs/latex/wx/outptstr.tex | 10 +++++----- docs/latex/wx/strmbase.tex | 8 ++++---- docs/latex/wx/strmfile.tex | 2 +- docs/latex/wx/topics.tex | 1 + 9 files changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/latex/wx/clipbrd.tex b/docs/latex/wx/clipbrd.tex index 4a48ba13b9..dcab3d5fb1 100644 --- a/docs/latex/wx/clipbrd.tex +++ b/docs/latex/wx/clipbrd.tex @@ -83,14 +83,14 @@ Call this function to close the clipboard, having opened it with \helpref{wxClip \membersection{wxClipboard::GetData}\label{wxclipboardgetdata} -\func{bool}{GetData}{\param{wxDataObject&}{ data}} +\func{bool}{GetData}{\param{wxDataObject\&}{ data}} Call this function to fill {\it data} with data on the clipboard, if available in the required format. Returns TRUE on success. \membersection{wxClipboard::IsSupported}\label{wxclipboardissupported} -\func{bool}{IsSupported}{\param{wxDataObject&}{ data}} +\func{bool}{IsSupported}{\param{wxDataObject\&}{ data}} Returns TRUE if the format of the given data object is available on the clipboard. diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index 573407deed..73b55f5b24 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -261,7 +261,7 @@ TRUE if the operation was successful. \membersection{wxFile::Write}\label{wxfilewrites} -\func{bool}{Write}{\param{const wxString& }{s}} +\func{bool}{Write}{\param{const wxString\& }{s}} Writes the contents of the string to the file, returns TRUE on success. diff --git a/docs/latex/wx/ftp.tex b/docs/latex/wx/ftp.tex index ea0e3796eb..2d58aea087 100644 --- a/docs/latex/wx/ftp.tex +++ b/docs/latex/wx/ftp.tex @@ -97,7 +97,7 @@ The default value of the user name is "anonymous". \wxheading{Remark} This parameter can be included in a URL if you want to use the URL manager. -For example, you can use: "ftp://a_user:a_password@a.host:service/a_directory/a_file" +For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file" to specify a user and a password. \membersection{wxFTP::SetPassword} @@ -115,7 +115,7 @@ user name and the host name of the local machine from the system. \wxheading{Remark} This parameter can be included in a URL if you want to use the URL manager. -For example, you can use: "ftp://a\_user:a\_password@a.host:service/a_directory/a\_file" +For example, you can use: "ftp://a\_user:a\_password@a.host:service/a\_directory/a\_file" to specify a user and a password. % ---------------------------------------------------------------------------- diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex index 509f27b02b..b6596637c3 100644 --- a/docs/latex/wx/http.tex +++ b/docs/latex/wx/http.tex @@ -42,10 +42,10 @@ to be reestablished: but you don't have to take care of this wxHTTP reestablishe \membersection{wxHTTP::SetHeader} -\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h_data}} +\func{void}{SetHeader}{\param{const wxString\&}{ header}, \param{const wxString\&}{ h\_data}} It sets data of a field to be sent during the next request to the HTTP server. The field -name is specified by \it{header} and the content by \it{h_data}. +name is specified by \it{header} and the content by \it{h\_data}. This is a low level function and it assumes that you know what you are doing. \membersection{wxHTTP::SetHeader} diff --git a/docs/latex/wx/inputstr.tex b/docs/latex/wx/inputstr.tex index ec8d55353f..0b940c020f 100644 --- a/docs/latex/wx/inputstr.tex +++ b/docs/latex/wx/inputstr.tex @@ -74,7 +74,7 @@ The buffer absolutely needs to have at least the specified size. This function returns a reference on the current object, so the user can test any states of the stream right away. -\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream_out}} +\func{wxInputStream\&}{Read}{\param{wxOutputStream\&}{ stream\_out}} Reads data from the input queue and stores it in the specified output stream. The data is read until an error is raised by one of the two streams. diff --git a/docs/latex/wx/outptstr.tex b/docs/latex/wx/outptstr.tex index 543c3e4b53..74378c89b6 100644 --- a/docs/latex/wx/outptstr.tex +++ b/docs/latex/wx/outptstr.tex @@ -43,7 +43,7 @@ Returns the stream buffer associated with the output stream. \membersection{wxOutputStream::LastWrite} -\constfunc{size_t}{LastWrite}{\void} +\constfunc{size\_t}{LastWrite}{\void} \membersection{wxOutputStream::PutC} @@ -54,19 +54,19 @@ stream position. \membersection{wxOutputStream::SeekO} -\func{off_t}{SeekO}{\param{off_t}{ pos}, \param{wxSeekMode}{ mode}} +\func{off\_t}{SeekO}{\param{off\_t}{ pos}, \param{wxSeekMode}{ mode}} Changes the stream current position. \membersection{wxOutputStream::TellO} -\constfunc{off_t}{TellO}{\void} +\constfunc{off\_t}{TellO}{\void} Returns the current stream position. \membersection{wxOutputStream::Write} -\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size_t}{ size}} +\func{wxOutputStream\&}{Write}{\param{const void *}{buffer}, \param{size\_t}{ size}} Writes the specified amount of bytes using the data of \it{buffer}. \it{WARNING!} The buffer absolutely needs to have at least the specified size. @@ -74,7 +74,7 @@ Writes the specified amount of bytes using the data of \it{buffer}. This function returns a reference on the current object, so the user can test any states of the stream right away. -\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream_in}} +\func{wxOutputStream\&}{Write}{\param{wxInputStream\&}{ stream\_in}} Reads data from the specified input stream and stores them in the current stream. The data is read until an error is raised diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 368252e9a7..7876d607b5 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -43,10 +43,10 @@ Destructor. This function returns the last error. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxStream_NOERROR}}{No error occured.} -\twocolitem{{\bf wxStream_EOF}}{An End-Of-File occured.} -\twocolitem{{\bf wxStream_WRITE_ERR}}{A generic error occured on the last write call.} -\twocolitem{{\bf wxStream_READ_ERR}}{A generic error occured on the last read call.} +\twocolitem{{\bf wxStream\_NOERROR}}{No error occured.} +\twocolitem{{\bf wxStream\_EOF}}{An End-Of-File occured.} +\twocolitem{{\bf wxStream\_WRITE\_ERR}}{A generic error occured on the last write call.} +\twocolitem{{\bf wxStream\_READ\_ERR}}{A generic error occured on the last read call.} \end{twocollist} \membersection{wxStreamBase::OnSysRead}\label{wxstreambaseonsysread} diff --git a/docs/latex/wx/strmfile.tex b/docs/latex/wx/strmfile.tex index c96b061022..fdbf8bae08 100644 --- a/docs/latex/wx/strmfile.tex +++ b/docs/latex/wx/strmfile.tex @@ -75,7 +75,7 @@ Returns TRUE if the stream is initialized and ready. Creates a new file with \it{ofilename} name and initializes the stream in write-only mode. -\func{}{wxFileOutputStream}{\param{wxFile&}{ file}} +\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}} Initializes a file stream in write-only mode using the file I/O object \it{file}. diff --git a/docs/latex/wx/topics.tex b/docs/latex/wx/topics.tex index b68151570f..3445cca3a8 100644 --- a/docs/latex/wx/topics.tex +++ b/docs/latex/wx/topics.tex @@ -40,4 +40,5 @@ This chapter contains a selection of topic overviews. \input tthreads.tex \input tfile.tex \input ti18n.tex +\input tstream.tex \input tusage.tex -- 2.45.2