Doc & Symantec C++ fixes

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

docs/latex/wx/closeevt.tex

@@ -17,7 +17,7 @@ functions that take a wxCloseEvent argument.
 event applies to wxFrame and wxDialog classes.}
 \twocolitem{{\bf EVT\_QUERY\_END\_SESSION(func)}}{Process a query end session event, supplying the member function.
 This event applies to wxApp only.}
-\twocolitem{{\bf EVT\__END\_SESSION(func)}}{Process an end session event, supplying the member function.
+\twocolitem{{\bf EVT\_END\_SESSION(func)}}{Process an end session event, supplying the member function.
 This event applies to wxApp only.}
 \end{twocollist}%
 

docs/latex/wx/filetype.tex

@@ -31,7 +31,7 @@ typically correspond to the extension ".txt", but may as well be associated with
 
 \wxheading{Required headers}
 
-#include <wx/mimetype.h>
+<wx/mimetype.h>
 
 \wxheading{Derived from}
 
@@ -64,10 +64,10 @@ function, for example:
 
 \begin{verbatim}
 // provide the message parameters for the MIME type manager
-class MailMessageParamaters : public wxFileType::MessageParameters
+class MailMessageParameters : public wxFileType::MessageParameters
 {
 public:
-   MailMessageParamaters(const wxString& filename,
+   MailMessageParameters(const wxString& filename,
                          const wxString& mimetype)
       : wxFileType::MessageParameters(filename, mimetype)
    {
@@ -85,7 +85,7 @@ public:
 \end{verbatim}
 
 Now you only need to create an object of this class and pass it to, for example,
-\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
+\rtfsp\helpref{GetOpenCommand}{wxfiletypegetopencommand} like this:
 
 \begin{verbatim}
 wxString command;
@@ -99,7 +99,6 @@ else
 {
     // we don't know how to handle such files...
 }
-
 \end{verbatim}
 
 {\bf Windows:} As only the file name is used by the program associated with the
@@ -107,25 +106,28 @@ given extension anyhow (but no other message parameters), there is no need to
 ever derive from MessageParameters class for a Windows-only program.
 
 \membersection{wxFileType::wxFileType}\label{wxfiletypewxfiletype}
+
 \func{}{wxFileType}{\void}
 
 The default constructor is private because you should never create objects of
-this type: they are only returned by 
-\helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
+this type: they are only returned by \helpref{wxMimeTypesManager}{wxmimetypesmanager} methods.
 
 \membersection{wxFileType::\destruct{wxFileType}}\label{wxfiletypedtor}
-\func{}{\destruct{wxFileType}{\void}
+
+\func{}{\destruct{wxFileType}}{\void}
 
 The destructor of this class is not virtual, so it should not be derived from.
 
 \membersection{wxFileType::GetMimeType}\label{wxfiletypegetmimetype}
-\func{bool}{GetMimeType}{\param{wxString *}{mimeType}}
+
+\func{bool}{GetMimeType}{\param{wxString*}{ mimeType}}
 
 If the function returns TRUE, the string pointed to by {\it mimeType} is filled
 with full MIME type specification for this file type: for example, "text/plain".
 
 \membersection{wxFileType::GetExtensions}\label{wxfiletypegetextensions}
-\func{bool}{GetExtensions}{\param{wxArrayString \&}{extensions}}
+
+\func{bool}{GetExtensions}{\param{wxArrayString\&}{ extensions}}
 
 If the function returns TRUE, the array {\it extensions} is filled
 with all extensions associated with this file type: for example, it may
@@ -139,7 +141,8 @@ by \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension
 function in the first place.
 
 \membersection{wxFileType::GetIcon}\label{wxfiletypegeticon}
-\func{bool}{GetIcon}{\param{wxIcon *}{icon}}
+
+\func{bool}{GetIcon}{\param{wxIcon*}{ icon}}
 
 If the function returns TRUE, the icon associated with this file type will be
 created and assigned to the {\it icon} parameter.
@@ -147,14 +150,16 @@ created and assigned to the {\it icon} parameter.
 {\bf Unix:} This function always returns FALSE under Unix.
 
 \membersection{wxFileType::GetDescription}\label{wxfiletypegetdescription}
-\func{bool}{GetDescription}{\param{wxString *}{desc}}
+
+\func{bool}{GetDescription}{\param{wxString*}{ desc}}
 
 If the function returns TRUE, the string pointed to by {\it desc} is filled
 with a brief description for this file type: for example, "text document" for
 the "text/plain" MIME type.
 
 \membersection{wxFileType::GetOpenCommand}\label{wxfiletypegetopencommand}
-\func{bool}{GetOpenCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
+
+\func{bool}{GetOpenCommand}{\param{wxString*}{ command}, \param{MessageParameters\&}{ params}}
 
 If the function returns TRUE, the string pointed to by {\it command} is filled
 with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -162,7 +167,8 @@ order to open the file of the given type. The name of the file is
 retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 
 \membersection{wxFileType::GetPrintCommand}\label{wxfiletypegetprintcommand}
-\func{bool}{GetPrintCommand}{\param{wxString *}{command},\param{MessageParameters \&}{params}}
+
+\func{bool}{GetPrintCommand}{\param{wxString*}{ command},\param{MessageParameters\&}{ params}}
 
 If the function returns TRUE, the string pointed to by {\it command} is filled
 with the command which must be executed (see \helpref{wxExecute}{wxexecute}) in
@@ -170,13 +176,15 @@ order to print the file of the given type. The name of the file is
 retrieved from \helpref{MessageParameters}{wxfiletypemessageparameters} class.
 
 \membersection{wxFileType::ExpandCommand}\label{wxfiletypeexpandcommand}
-\func{static wxString}{ExpandCommand}{\param{const wxString \&}{command},\param{MessageParameters \&}{params}}
+
+\func{static wxString}{ExpandCommand}{\param{const wxString\&}{ command}, \param{MessageParameters\&}{ params}}
 
 This function is primarly intended for GetOpenCommand and GetPrintCommand
 usage but may be also used by the application directly if, for example, you want
 to use some non default command to open the file.
 
 The function replaces all occurences of
+
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{format specificator}{with}
@@ -184,6 +192,7 @@ The function replaces all occurences of
 \twocolitem{\%t}{the MIME type}
 \twocolitem{\%\{param\}}{the value of the parameter {\it param}}
 \end{twocollist}
+
 using the MessageParameters object you pass to it.
 
 If there is no '\%s' in the command string (and the string is not empty), it is
@@ -192,3 +201,4 @@ as "< \%s" were appended to the string.
 
 Unlike all other functions of this class, there is no error return for this
 function.
+

docs/latex/wx/helpinst.tex

@@ -19,7 +19,7 @@ appropriate class is aliased to the name wxHelpController for each platform.
 
 There are currently the following help controller classes defined:
 
-\begin{itemize}\itemsep=0
+\begin{itemize}\itemsep=0pt
 \item wxWinHelpController, for controlling Windows Help.
 \item wxExtHelpController, for controlling external browsers under Unix.
 The default browser is Netscape Navigator.

docs/latex/wx/image.tex

@@ -419,8 +419,6 @@ Returns TRUE if the images were unequal, FALSE otherwise.
 
 \section{\class{wxImageHandler}}\label{wximagehandler}
 
-\overview{Overview}{wximageoverview}
-
 This is the base class for implementing image file loading/saving, and image creation from data.
 It is used within wxImage and is not normally seen by the application.
 

docs/latex/wx/menuitem.tex

@@ -11,7 +11,7 @@ wxOwnerDrawn (Windows only)\\
 
 \wxheading{See also}
 
-\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}, \helpref{wxOwnerDrawn}{wxownerdrawn}
+\helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

docs/latex/wx/mimetype.tex

@@ -24,7 +24,7 @@ but it will support modifying it as well in the future versions.
 
 \wxheading{Required headers}
 
-#include <wx/mimetype.h>
+<wx/mimetype.h>
 
 \wxheading{Derived from}
 
@@ -46,18 +46,18 @@ program.
 
 \membersection{Query database}
 
-These functions are the heart of this class: they allow to find a 
-\helpref{file type}{wxfiletype} object from either file extension or MIME type.
+These functions are the heart of this class: they allow to find a \helpref{file type}{wxfiletype} object
+from either file extension or MIME type.
 If the function is successful, it returns a pointer to the wxFileType object
-which {\bf must be deleted by the caller}, otherwise NULL will be returned.
+which {\bf must} be deleted by the caller, otherwise NULL will be returned.
 
 \helpref{GetFileTypeFromMimeType}{wxmimetypesmanagergetfiletypefrommimetype}\\
 \helpref{GetFileTypeFromExtension}{wxmimetypesmanagergetfiletypefromextension}
 
-\membersection{Initialization functions}
+\membersection{Initialization functions}\label{wxmimetypesmanagerinit}
 
-{\bf Unix:} These functions may be used to load additional (except for the
-default ones which are loaded automatically) files containing MIME
+{\bf Unix:} These functions may be used to load additional files (except for the
+default ones which are loaded automatically) containing MIME
 information in either mailcap(5) or mime.types(5) format.
 
 \helpref{ReadMailcap}{wxmimetypesmanagerreadmailcap}\\
@@ -71,6 +71,7 @@ information in either mailcap(5) or mime.types(5) format.
 }}
 
 \membersection{wxMimeTypesManager::wxMimeTypesManager}\label{wxmimetypesmanagerctor}
+
 \func{}{wxMimeTypesManager}{\void}
 
 Constructor puts the object in the "working" state, no additional initialization
@@ -78,34 +79,40 @@ are needed - but \helpref{ReadXXX}{wxmimetypesmanagerinit} may be used to load
 additional mailcap/mime.types files.
 
 \membersection{wxMimeTypesManager::\destruct{wxMimeTypesManager}}\label{wxmimetypesmanagerdtor}
-\func{}{\destruct{wxMimeTypesManager}{\void}
+
+\func{}{\destruct{wxMimeTypesManager}}{\void}
 
 Destructor is not virtual, so this class should not be derived from.
 
 \membersection{wxMimeTypesManager::GetFileTypeFromExtension}\label{wxmimetypesmanagergetfiletypefromextension}
-\func{wxFileType *}{GetFileTypeFromExtension}{\param{const wxString \&}{extension}}
+
+\func{wxFileType*}{GetFileTypeFromExtension}{\param{const wxString\&}{ extension}}
 
 Gather information about the files with given extension and return the
 corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the extension
 is unknown.
 
 \membersection{wxMimeTypesManager::GetFileTypeFromMimeType}\label{wxmimetypesmanagergetfiletypefrommimetype}
-\func{wxFileType *}{GetFileTypeFromMimeType}{\param{const wxString \&}{mimeType}}
+
+\func{wxFileType*}{GetFileTypeFromMimeType}{\param{const wxString\&}{ mimeType}}
 
 Gather information about the files with given MIME type and return the
 corresponding \helpref{wxFileType}{wxfiletype} object or NULL if the MIME type
 is unknown.
 
 \membersection{wxMimeTypesManager::ReadMailcap}\label{wxmimetypesmanagerreadmailcap}
-\func{\void}{ReadMailcap}{\param{const wxString \&}{filename}}
+
+\func{void}{ReadMailcap}{\param{const wxString\&}{ filename}}
 
 Load additional file containing information about MIME types and associated
 information in mailcap format. See metamail(1) and mailcap(5) for more
 information.
 
 \membersection{wxMimeTypesManager::ReadMimeTypes}\label{wxmimetypesmanagerreadmimetypes}
-\func{\void}{ReadMimeTypes}{\param{const wxString \&}{filename}}
+
+\func{void}{ReadMimeTypes}{\param{const wxString\&}{ filename}}
 
 Load additional file containing information about MIME types and associated
 information in mime.types file format. See metamail(1) and mailcap(5) for more
 information.
+

docs/latex/wx/mutexlck.tex

@@ -13,24 +13,27 @@ None.
 
 \wxheading{See also}
 
-\helpref{wxMutex}{wxmutex},
-\helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
+\helpref{wxMutex}{wxmutex}, \helpref{wxCriticalSectionLocker}{wxcriticalsectionlocker}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxMutexLocker::wxMutexLocker}\label{wxmutexlockerctor}
+
 \func{}{wxMutexLocker}{\param{wxMutex *}{mutex}}
 
 Constructs a wxMutexLocker object associated with mutex which must be non NULL
-and locks it. Call \helpref{IsOk}{wxmutexisok} to check if the mutex was
+and locks it. Call \helpref{IsLocked}{wxmutexlockerisok} to check if the mutex was
 successfully locked.
 
 \membersection{wxMutexLocker::\destruct{wxMutexLocker}}\label{wxmutexlockerdtor}
+
 \func{}{\destruct{wxMutexLocker}}{\void}
 
 Destuctor releases the mutex if it was successfully acquired in the ctor.
 
 \membersection{wxMutexLocker::IsOk}\label{wxmutexlockerisok}
+
 \constfunc{bool}{IsOk}{\void}
 
 Returns TRUE if mutex was acquired in the constructor, FALSE otherwise.
+

docs/latex/wx/noteevt.tex

@@ -16,9 +16,9 @@ functions that take a wxNotebookEvent argument.
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGED(id, func)}}{The page selection was changed. Processes a
+\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGED(id, func)}}{The page selection was changed. Processes a
 wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.}
-\twocolitem{{\bf EVT\_NOTEBOOK_PAGE_CHANGING(id, func)}}{The page selection is about to be changed.
+\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed.
 Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event.}
 \end{twocollist}%
 

docs/latex/wx/sashwin.tex

@@ -182,9 +182,6 @@ Call this function to make a sash visible or invisible on a particular edge.
 
 \helpref{wxSashWindow::GetSashVisible}{wxsashwindowgetsashvisible}
 
-    // Set whether there's a border in this position
-    inline void SetSashBorder(wxSashEdgePosition edge, bool border) { m_sashes[edge].m_border = border; }
-
 \membersection{wxSashWindow::SetSashBorder}\label{wxsashwindowsetsashborder}
 
 \func{void}{SetSashBorder}{\param{wxSashEdgePosition }{edge}, \param{bool}{ hasBorder}}

docs/latex/wx/tdnd.tex

@@ -92,7 +92,7 @@ this, \helpref{GetFormatCount}{wxdroptargetgetformatcount} and \helpref{GetForma
 used and if the format is
 supported (i.e. is one of returned by GetFormat()), 
 then \helpref{OnDrop}{wxdroptargetondrop} is called. 
-Otherwise, \helpref{wxDragNone}{stdformat} is returned by DoDragDrop() and
+Otherwise, wxDragNone is returned by DoDragDrop() and
 nothing happens.
 
 \item {\bf The end:} After processing the data, DoDragDrop() returns either