Doc fixes

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

docs/latex/wx/category.tex

@@ -188,7 +188,7 @@ An event object contains information about a specific event. Event handlers
 \twocolitem{\helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent}}{Used to calculate window layout}
 \twocolitem{\helpref{wxCloseEvent}{wxcloseevent}}{A close window or end session event}
 \twocolitem{\helpref{wxCommandEvent}{wxcommandevent}}{An event from a variety of standard controls}
-\twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}}{wxdialupmanager}
+\twocolitem{\helpref{wxDialUpEvent}{wxdialupevent}}{Event send by \helpref{wxDialUpManager}{wxdialupmanager}}
 \twocolitem{\helpref{wxDropFilesEvent}{wxdropfilesevent}}{A drop files event}
 \twocolitem{\helpref{wxEraseEvent}{wxeraseevent}}{An erase background event}
 \twocolitem{\helpref{wxEvent}{wxevent}}{The event base class}
@@ -210,7 +210,7 @@ An event object contains information about a specific event. Event handlers
 \twocolitem{\helpref{wxScrollWinEvent}{wxscrollwinevent}}{A scroll event from scrolled windows}
 \twocolitem{\helpref{wxSizeEvent}{wxsizeevent}}{A size event}
 \twocolitem{\helpref{wxSocketEvent}{wxsocketevent}}{A socket event}
-\twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}.}
+\twocolitem{\helpref{wxSpinEvent}{wxspinevent}}{An event from \helpref{wxSpinButton}{wxspinbutton}}
 \twocolitem{\helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}}{A system colour change event}
 \twocolitem{\helpref{wxTabEvent}{wxtabevent}}{A tab control event}
 \twocolitem{\helpref{wxTreeEvent}{wxtreeevent}}{A tree control event}

docs/latex/wx/config.tex

@@ -321,7 +321,7 @@ would be to prefix the offending symbols with a backslash.
 The following functions control this option:
 
 \helpref{IsExpandingEnvVars}{wxconfigbaseisexpandingenvvars}\\
-\helpref{SetExpandingEnvVars}{wxconfigbasesetexpandingenvvars}\\
+\helpref{SetExpandEnvVars}{wxconfigbasesetexpandenvvars}\\
 \helpref{SetRecordDefaults}{wxconfigbasesetrecorddefaults}\\
 \helpref{IsRecordingDefaults}{wxconfigbaseisrecordingdefaults}
 
@@ -407,8 +407,7 @@ for use by desinstallation routine.
 
 \membersection{wxConfigBase::DeleteEntry}\label{wxconfigbasedeleteentry}
 
-\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{
+\func{bool}{DeleteEntry}{\param{const wxString\& }{ key}, \param{bool}{ bDeleteGroupIfEmpty = TRUE}}
-bDeleteGroupIfEmpty = TRUE}}
 
 Deletes the specified entry and the group it belongs to if it was the last key
 in it and the second parameter is true.
@@ -471,8 +470,7 @@ The result is an element of enum EntryType:
 
 \membersection{wxConfigBase::GetFirstGroup}\label{wxconfigbasegetfirstgroup}
 
-\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{
+\constfunc{bool}{GetFirstGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
-index}}
 
 Gets the first group.
 
@@ -482,8 +480,7 @@ the next call.}
 
 \membersection{wxConfigBase::GetFirstEntry}\label{wxconfigbasegetfirstentry}
 
-\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{
+\constfunc{bool}{GetFirstEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
-index}}
 
 Gets the first entry.
 
@@ -493,8 +490,7 @@ the next call.}
 
 \membersection{wxConfigBase::GetNextGroup}\label{wxconfigbasegetnextgroup}
 
-\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{
+\constfunc{bool}{GetNextGroup}{\param{wxString\& }{str}, \param{long\&}{ index}}
-index}}
 
 Gets the next group.
 
@@ -504,8 +500,7 @@ the next call.}
 
 \membersection{wxConfigBase::GetNextEntry}\label{wxconfigbasegetnextentry}
 
-\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{
+\constfunc{bool}{GetNextEntry}{\param{wxString\& }{str}, \param{long\&}{ index}}
-index}}
 
 Gets the next entry.
 
@@ -556,20 +551,18 @@ Returns TRUE if we are expanding environment variables in key values.
 
 \membersection{wxConfigBase::IsRecordingDefaults}\label{wxconfigbaseisrecordingdefaults}
 
-\func{bool}{IsRecordingDefaults}{\void} const
+\constfunc{bool}{IsRecordingDefaults}{\void}
 
 Returns TRUE if we are writing defaults back to the config file.
 
 \membersection{wxConfigBase::Read}\label{wxconfigbaseread}
 
-\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
+\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}}
-str}}
 
 Read a string from the key, returning TRUE if the value was read. If the key
 was not found, {\it str} is not changed.
 
-\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{
+\constfunc{bool}{Read}{\param{const wxString\& }{key}, \param{wxString*}{ str}, \param{const wxString\& }{defaultVal}}
-str}, \param{const wxString\& }{defaultVal}}
 
 Read a string from the key. The default value is returned if the key was not
 found.
@@ -592,8 +585,7 @@ not found, {\it l} is not changed.
 Reads a long value, returning TRUE if the value was found. If the value was
 not found, {\it defaultVal} is used instead.
 
-\constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{
+\constfunc{long }{Read}{\param{const wxString\& }{key}, \param{long}{ defaultVal}}
-defaultVal}}
 
 Reads a long value from the key and returns it. {\it defaultVal} is returned
 if the key is not found.
@@ -667,7 +659,7 @@ exists.
 Sets the config object as the current one, returns the pointer to the previous
 current object (both the parameter and returned value may be NULL)
 
-\membersection{wxConfigBase::SetExpandingEnvVars}\label{wxconfigbasesetexpandingenvvars}
+\membersection{wxConfigBase::SetExpandEnvVars}\label{wxconfigbasesetexpandenvvars}
 
 \func{void}{SetExpandEnvVars }{\param{bool }{bDoIt = TRUE}}
 

docs/latex/wx/db.tex

@@ -109,3 +109,4 @@ At the end of your program, when you have finished all of your database work, yo
       // Error freeing environment handle
    }
 \end{verbatim}
+

docs/latex/wx/dialog.tex

@@ -31,6 +31,7 @@ dialog to respond to system close events.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxDIALOG\_MODAL}}{Specifies that the dialog box will be modal.}
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the dialog box (Motif only).}
 \twocolitem{\windowstyle{wxDEFAULT\_DIALOG\_STYLE}}{Equivalent to a combination of wxCAPTION, wxSYSTEM\_MENU and wxTHICK\_FRAME}
 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Display a resizeable frame around the window (Unix only).}

docs/latex/wx/dialup.tex

@@ -156,7 +156,7 @@ confirmation or give him a possibility to override it.
 Returns {\tt TRUE} if the computer is connected to the network: under Windows,
 this just means that a RAS connection exists, under Unix we check that
 the "well-known host" (as specified by 
-\helpref{SetWellKnownHost}{wxdialupmanagersetwellknownhost}) is reachable
+\helpref{SetWellKnownHost}{wxdialupmanagersetwellknownhost}) is reachable.
 
 \membersection{wxDialUpManager::SetOnlineStatus}\label{wxdialupmanagersetonlinestatus}
 
@@ -203,7 +203,7 @@ is always safe to call. The default value is {\tt www.yahoo.com:80}.
 
 \membersection{wxDialUpManager::SetConnectCommand}\label{wxdialupmanagersetconnectcommand}
 
-\func{}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}
+\func{}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
 
 This method is for Unix only.
 
@@ -212,3 +212,4 @@ Sets the commands to start up the network and to hang up again.
 \wxheading{See also}
 
 \helpref{Dial}{wxdialupmanagerdial}
+

docs/latex/wx/mbcnvfil.tex

@@ -3,7 +3,6 @@
 % ../include/wx/strconv.h at 25/Mar/00 10:20:56
 %
 
-
 \section{\class{wxMBConvFile}}\label{wxmbconvfile}
 
 This class converts file names between filesystem multibyte encoding and
@@ -47,3 +46,4 @@ Converts from multibyte filename encoding to Unicode. Returns the size of the de
 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
 
 Converts from Unicode to multibyte filename encoding. Returns the size of the destination buffer.
+

docs/latex/wx/mbcnvut7.tex

@@ -3,7 +3,6 @@
 % ../include/wx/strconv.h at 25/Mar/00 10:20:56
 %
 
-
 \section{\class{wxMBConvUTF7}}\label{wxmbconvutf7}
 
 This class converts between the UTF-7 encoding and Unicode.
@@ -25,7 +24,6 @@ Unfortunately, this class is not quite implemented yet.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-
 \membersection{wxMBConvUTF7::MB2WC}\label{wxmbconvutf7mb2wc}
 
 \constfunc{size\_t}{MB2WC}{\param{wchar\_t* }{buf}, \param{const char* }{psz}, \param{size\_t }{n}}
@@ -37,3 +35,4 @@ Converts from UTF-7 encoding to Unicode. Returns the size of the destination buf
 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
 
 Converts from Unicode to UTF-7 encoding. Returns the size of the destination buffer.
+

docs/latex/wx/mbcnvut8.tex

@@ -3,7 +3,6 @@
 % ../include/wx/strconv.h at 25/Mar/00 10:20:56
 %
 
-
 \section{\class{wxMBConvUTF8}}\label{wxmbconvutf8}
 
 This class converts between the UTF-8 encoding and Unicode.
@@ -57,3 +56,4 @@ Converts from UTF-8 encoding to Unicode. Returns the size of the destination buf
 \constfunc{size\_t}{WC2MB}{\param{char* }{buf}, \param{const wchar\_t* }{psz}, \param{size\_t }{n}}
 
 Converts from Unicode to UTF-8 encoding. Returns the size of the destination buffer.
+

docs/latex/wx/mbconv.tex

@@ -3,7 +3,6 @@
 % ../include/wx/strconv.h at 25/Mar/00 10:20:56
 %
 
-
 \section{\class{wxMBConv}}\label{wxmbconv}
 
 This class is the base class of a hierarchy of classes capable of converting
@@ -106,3 +105,4 @@ Converts from the current wxChar type to Unicode. If wxChar is wchar\_t,
 it returns the parameter unaltered. If wxChar is char, it returns the
 result in a wxWCharBuffer. The macro wxWX2WCbuf is defined as the correct
 return type (without const).
+

docs/latex/wx/table.tex

@@ -24,3 +24,4 @@ a table contained within the associated ODBC data source
 \func{}{wxTable}{\void}
 
 Default constructor.
+

docs/latex/wx/tconfig.tex

@@ -13,7 +13,7 @@ information. They were especially designed for this usage and, although may
 probably be used for many other things as well, should be limited to it. It
 means that this information should be:
 
-\begin{enumerate}
+\begin{enumerate}\itemsep=0pt
 \item Typed, i.e. strings or numbers for the moment. You can not store
 binary data, for example.
 \item Small. For instance, it is not recommended to use the Windows

docs/latex/wx/tdate.tex

@@ -11,7 +11,7 @@
 
 \section{Date and time classes overview}\label{wxdatetimeoverview}
 
-Classes: \helpref{wxDateTime}{wxdatetime}, \helpref{wxDateSpan}{wxdatespan}, \helpref{wxTimeSpan}, \helpref{wxtimespan}, \helpref{wxCalendarCtrl}{wxcalendarctrl}
+Classes: \helpref{wxDateTime}{wxdatetime}, \helpref{wxDateSpan}{wxdatespan}, \helpref{wxTimeSpan}{wxtimespan}, \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
 \subsection{Introduction}
 
@@ -20,15 +20,15 @@ of the supported features of \helpref{wxDateTime}{wxdatetime} class are:
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\item{Wide range}{The range of supported dates goes from about 4714 B.C. to
+\twocolitem{Wide range}{The range of supported dates goes from about 4714 B.C. to
 some 480 million years in the future.}
-\item{Precision}{Not using floating point calculations anywhere ensures that
+\twocolitem{Precision}{Not using floating point calculations anywhere ensures that
 the date calculations don't suffer from rounding errors.}
-\item{Many features}{Not only all usual calculations with dates are supported,
+\twocolitem{Many features}{Not only all usual calculations with dates are supported,
 but also more exotic week and year day calculations, work day testing, standard
 astronomical functions, conversion to and from strings in either strict or free
 format.}
-\item{Efficiency}{Objects of wxDateTime are small (8 bytes) and working with
+\twocolitem{Efficiency}{Objects of wxDateTime are small (8 bytes) and working with
 them is fast}
 \end{twocollist}
 
@@ -120,7 +120,7 @@ perfectly valid.
 
 Here is what can be done:
 
-\begin{twocollist}
+\begin{twocollist}\itemsep=0pt
 \item{{\bf Addition}}{a wxTimeSpan or wxDateSpan can be added to wxDateTime
 resulting in a new wxDateTime object and also 2 objects of the same span class
 can be added together giving another object of the smae class.}
@@ -175,9 +175,9 @@ simply print time in any time zone.
 To see how to do it, the last issue to address is how to construct a TimeZone
 object which must be passed to all these methods. First of all, you may construct
 it manually by specifying the time zone offset in seconds from GMT, but
-usually you will just use one of the \helpref{symbolic time zone
+usually you will just use one of the \helpref{symbolic time zone names}{wxdatetimetimezones} and
-names}{wxdatetimetimezones} and let the conversion constructor do the job.
+let the conversion constructor do the job.
-I.e.. you would just write
+I.e. you would just write
 
 \begin{verbatim}
 wxDateTime dt(...whatever...);
@@ -215,3 +215,4 @@ The old classes for date/time manipulations ported from wxWindows version 1.xx
 are still included but are reimplemented in terms of wxDateTime. However, using
 them is strongly discouraged because they have a few quirks/bugs and were not
 `Y2K' compatible.
+

docs/latex/wx/thread.tex

@@ -43,7 +43,7 @@ None.
 
 \membersection{wxThread::wxThread}\label{wxthreadctor}
 
-\func{}{wxThread}{\param{wxThreadKind }{kind = wxTHREAD\_DETACHED}
+\func{}{wxThread}{\param{wxThreadKind }{kind = wxTHREAD\_DETACHED}}
 
 Constructor creates a new detached (default) or joinable C++ thread object. It
 does not create (or starts execution of) the real thread - for this you should
@@ -333,8 +333,7 @@ See also \helpref{Sleep()}{wxthreadsleep}.
 
 \constfunc{ExitCode}{Wait}{\void}
 
-Waits until the thread terminates and returns its exit code or {\tt
+Waits until the thread terminates and returns its exit code or {\tt (ExitCode)-1} on error.
-(ExitCode)-1} on error.
 
 You can only Wait() for joinable (not detached) threads.
 

docs/latex/wx/treectrl.tex

@@ -442,8 +442,8 @@ Returns the state image list (from which application-defined state images are ta
 
 \func{wxTreeItemId}{HitTest}{\param{const wxPoint\& }{point}, \param{int\& }{flags}}
 
-Calculates which (if any) item is under the given point, returning extra information
+Calculates which (if any) item is under the given point, returning the tree item
-in {\it flags}. {\it flags} is a bitlist of the following:
+id at this point plus extra information {\it flags}. {\it flags} is a bitlist of the following:
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

docs/latex/wx/wizard.tex

@@ -106,3 +106,4 @@ Get the current page while the wizard is running. {\tt NULL} is returned if
 \constfunc{wxSize}{GetPageSize}{\void}
 
 Returns the size available for the pages.
+

docs/latex/wx/wxPython.tex

@@ -13,7 +13,7 @@ wxPython is a blending of the wxWindows GUI classes and the
 
 \wxheading{Python}
 
-So what is Python?  Go to
+So what is Python?  Go to 
 \urlref{http://www.python.org}{http://www.python.org} to learn more,
 but in a nutshell Python is an interpreted,
 interactive, object-oriented programming language. It is often
@@ -129,7 +129,7 @@ generated C++ code is included under the src directory.
 
 I added a few minor features to SWIG to control some of the code
 generation. If you want to play around with this you will need to get
-a recent version of SWIG from their CVS or from a daily build. See
+a recent version of SWIG from their CVS or from a daily build. See 
 \urlref{http://www.swig.org/}{http://www.swig.org/} for details.
 
 wxPython is organized as a Python package. This means that the
@@ -183,7 +183,7 @@ utility again.
 
 {\tt python demo.py}
 
-To run it without requiring a console on Win32, you can use the
+To run it without requiring a console on Win32, you can use the 
 {\tt pythonw.exe} version of Python either from the command line or from a
 shortcut.
 \end{enumerate}

docs/latex/wx/wxstring.tex

@@ -882,7 +882,7 @@ doesn't change this string.
 
 \membersection{wxString::SubString}\label{wxstringsubstring}
 
-\constfunc{wxString}{SubString}{\param{size\_t}{ to}, \param{size\_t}{ from}}
+\constfunc{wxString}{SubString}{\param{size\_t}{ from}, \param{size\_t}{ to}}
 
 Same as \helpref{Mid}{wxstringmid}.