From 418ab1e742d1da28f69f0871adc6df5f697bc7c0 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 21 Sep 2006 21:00:00 +0000 Subject: [PATCH 1/1] fix unescaped underscores git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41358 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/framemanager.tex | 18 +++++++++--------- docs/latex/wx/function.tex | 4 ++-- docs/latex/wx/glcanvas.tex | 8 ++++---- docs/latex/wx/glcontext.tex | 2 +- docs/latex/wx/url.tex | 6 +++--- docs/latex/wx/wxstring.tex | 2 +- docs/latex/wx/xmldocument.tex | 14 +++++++------- 7 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/latex/wx/framemanager.tex b/docs/latex/wx/framemanager.tex index cc2385d487..ba538ba21a 100644 --- a/docs/latex/wx/framemanager.tex +++ b/docs/latex/wx/framemanager.tex @@ -124,8 +124,8 @@ enum wxFrameManagerOption \func{}{wxFrameManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}} -Constructor. {\it frame} specifies the wxFrame which should be managed. -{\it flags} specifies options which allow the frame management behavior +Constructor. \arg{frame} specifies the wxFrame which should be managed. +\arg{flags} specifies options which allow the frame management behavior to be modified. \membersection{wxFrameManager::\destruct{wxFrameManager}}\label{wxframemanagerdtor} @@ -201,7 +201,7 @@ Returns the frame currently being managed by wxFrameManager. \func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}} -{\it GetPane]} is used to lookup a wxPaneInfo object +{\it GetPanel} is used to lookup a wxPaneInfo object either by window pointer or by pane name, which acts as a unique id for a window pane. The returned wxPaneInfo object may then be modified to change a pane's look, state or position. After one or more @@ -240,10 +240,10 @@ returned wxPaneInfo's IsOk() method will return false. This method is used to insert either a previously unmanaged pane window into the frame manager, or to insert a currently managed pane somewhere else. {\it InsertPane} will push all panes, rows, or docks aside and -insert the window into the position specified by insert_location. -Because insert_location can specify either a pane, dock row, or dock -layer, the insert_level parameter is used to disambiguate this. The -parameter insert_level can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW +insert the window into the position specified by \arg{insert\_location}. +Because \arg{insert\_location} can specify either a pane, dock row, or dock +layer, the \arg{insert\_level} parameter is used to disambiguate this. The +parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW or wxAUI\_INSERT\_DOCK. \membersection{wxFrameManager::LayoutAddDock}\label{wxframemanagerlayoutadddock} @@ -320,7 +320,7 @@ interface will return to the state it was when the perspective was saved. \func{void}{SetArtProvider}{\param{wxDockArt* }{art\_provider}} Instructs wxFrameManager to use art provider specified by parameter -{\it art_provider} for all drawing calls. This allows plugable +\arg{art\_provider} for all drawing calls. This allows plugable look-and-feel features. The previous art provider object, if any, will be deleted by wxFrameManager. @@ -328,7 +328,7 @@ will be deleted by wxFrameManager. \func{void}{SetFlags}{\param{unsigned int }{flags}} -This method is used to specify wxFrameManager's settings flags. {\it flags} +This method is used to specify wxFrameManager's settings flags. \arg{flags} specifies options which allow the frame management behavior to be modified. \membersection{wxFrameManager::SetManagedWindow}\label{wxframemanagersetmanagedwindow} diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 07e674a0cd..20e484ecf9 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1746,11 +1746,11 @@ wxGetTranslation wouldn't find them. The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list } argument instead of arbitrary number of parameters. -Note that if \texttt{wxUSE_PRINTF_POS_PARAMS} is set to 1, then this function supports +Note that if \texttt{wxUSE\_PRINTF\_POS\_PARAMS} is set to 1, then this function supports positional arguments (see \helpref{wxString::Printf}{wxstringprintf} for more information). However other functions of the same family (wxPrintf, wxSprintf, wxFprintf, wxVfprintf, wxVfprintf, wxVprintf, wxVsprintf) currently do not to support positional parameters -even when \texttt{wxUSE_PRINTF_POS_PARAMS} is 1. +even when \texttt{wxUSE\_PRINTF\_POS\_PARAMS} is 1. \wxheading{See also} diff --git a/docs/latex/wx/glcanvas.tex b/docs/latex/wx/glcanvas.tex index 6850918ac1..13840d5cf4 100644 --- a/docs/latex/wx/glcanvas.tex +++ b/docs/latex/wx/glcanvas.tex @@ -12,7 +12,7 @@ to show the OpenGL buffer on the window. For the newer (wx 2.7.x+) method, create a wxGLCanvas window using the constructor that does \emph{not} create an implicit rendering context, create an explicit instance of a \helpref{wxGLContext}{wxglcontext} that is initialized with the wxGLCanvas yourself, -then use either \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent_rc} with the instance of the \helpref{wxGLContext}{wxglcontext} +then use either \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrentrc} with the instance of the \helpref{wxGLContext}{wxglcontext} or \helpref{wxGLContext::SetCurrent}{wxglcontextsetcurrent} with the instance of the \helpref{wxGLCanvas}{wxglcanvas} to bind the OpenGL state that is represented by the rendering context to the canvas, and then call \helpref{wxGLCanvas::SwapBuffers}{wxglcanvasswapbuffers} to swap the buffers of the OpenGL canvas and thus show your current output. @@ -91,7 +91,7 @@ alpha channel, and accum buffer. Other implementations may support them. \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"}, \param{int*}{ attribList = 0}, \param{const wxPalette\&}{ palette = wxNullPalette}} -\func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id = wxID_ANY}, +\func{void}{wxGLCanvas}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id = wxID\_ANY}, \param{int*}{ attribList = 0}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style=0}, \param{const wxString\& }{name="GLCanvas"}, @@ -108,7 +108,7 @@ Note that if you used one of the first three constructors, \helpref{wxGLCanvas:: returns the pointer to the implicitly created instance, and the \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent} method \emph{without} the parameter should be used. If however you used the fourth constructor, \helpref{wxGLCanvas::GetContext}{wxglcanvasgetcontext} always returns NULL -and the \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent_rc} method \emph{with} the parameter must be used! +and the \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrentrc} method \emph{with} the parameter must be used! \docparam{parent}{Pointer to a parent window.} @@ -166,7 +166,7 @@ If this canvas was created with the fourth constructor, this method should not b Note that this function may only be called \emph{after} the window has been shown. -\membersection{wxGLCanvas::SetCurrent}\label{wxglcanvassetcurrent_rc} +\membersection{wxGLCanvas::SetCurrent}\label{wxglcanvassetcurrentrc} \func{void}{SetCurrent}{ \param{const wxGLContext&}{ RC} } diff --git a/docs/latex/wx/glcontext.tex b/docs/latex/wx/glcontext.tex index 692288e9ac..cf6f8e5b28 100644 --- a/docs/latex/wx/glcontext.tex +++ b/docs/latex/wx/glcontext.tex @@ -52,4 +52,4 @@ with equivalent attributes as {\it win}.} Makes the OpenGL state that is represented by this rendering context current with the wxGLCanvas {\it win}. Note that {\it win} can be a different wxGLCanvas window than the one that was passed to the constructor of this rendering context. If { \it RC } is an object of type wxGLContext, the statements { \it RC.SetCurrent(win); } and { \it win.SetCurrent(RC); } are equivalent, -see \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrent_rc}. +see \helpref{wxGLCanvas::SetCurrent}{wxglcanvassetcurrentrc}. diff --git a/docs/latex/wx/url.tex b/docs/latex/wx/url.tex index 4262d67780..1038ef9487 100644 --- a/docs/latex/wx/url.tex +++ b/docs/latex/wx/url.tex @@ -33,7 +33,7 @@ and comparison operators. Constructs a URL object from the string. The URL must be valid according to RFC 1738. In particular, file URLs must be of the format {\tt file://hostname/path/to/file} otherwise \helpref{GetError}{wxurlgeterror} -will return a value different from {\tt wxURL_NOERR}. +will return a value different from {\tt wxURL\_NOERR}. It is valid to leave out the hostname but slashes must remain in place - i.e. a file URL without a hostname must contain three consecutive slashes @@ -123,7 +123,7 @@ Returns the initialized stream. You will have to delete it yourself. \constfunc{bool}{IsOk}{\void} Returns \true if this object is correctly initialized, i.e. if -\helpref{GetError}{wxurlgeterror} returns {\tt wxURL_NOERR}. +\helpref{GetError}{wxurlgeterror} returns {\tt wxURL\_NOERR}. % @@ -165,5 +165,5 @@ Sets the proxy to use for this URL. \func{wxURLError}{SetURL}{\param{const wxString\&}{ url}} -Initializes this object with the given URL and returns {\tt wxURL_NOERR} +Initializes this object with the given URL and returns {\tt wxURL\_NOERR} if it's valid (see \helpref{GetError}{wxurlgeterror} for more info). diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex index 1ed930cc20..85529acf02 100644 --- a/docs/latex/wx/wxstring.tex +++ b/docs/latex/wx/wxstring.tex @@ -897,7 +897,7 @@ Prepends {\it str} to this string, returning a reference to this string. Similar to the standard function {\it sprintf()}. Returns the number of characters written, or an integer less than zero on error. -Note that if {\tt wxUSE_PRINTF_POS_PARAMS} is set to 1, then this function supports +Note that if {\tt wxUSE\_PRINTF\_POS\_PARAMS} is set to 1, then this function supports Unix98-style positional parameters: \begin{verbatim} diff --git a/docs/latex/wx/xmldocument.tex b/docs/latex/wx/xmldocument.tex index 0a5bcb5b12..9eafe3d020 100644 --- a/docs/latex/wx/xmldocument.tex +++ b/docs/latex/wx/xmldocument.tex @@ -91,11 +91,11 @@ doc.Save(wxT("myfile2.xml")); // myfile2.xml != myfile.xml \func{}{wxXmlDocument}{\void} -\func{}{wxXmlDocument}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\func{}{wxXmlDocument}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} Loads the given {\it filename} using the given encoding. See \helpref{Load()}{wxxmldocumentload}. -\func{}{wxXmlDocument}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\func{}{wxXmlDocument}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} Loads the XML document from given stream using the given encoding. See \helpref{Load()}{wxxmldocumentload}. @@ -166,12 +166,12 @@ Returns \true if the document has been loaded successfully. \membersection{wxXmlDocument::Load}\label{wxxmldocumentload} -\func{bool}{Load}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\func{bool}{Load}{\param{const wxString\& }{filename}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} Parses {\it filename} as an xml document and loads its data. -If {\tt flags} does not contain {\tt wxXMLDOC_KEEP_WHITESPACE_NODES}, then, while loading, all nodes of -type {\tt wxXML_TEXT_NODE} (see \helpref{wxXmlNode}{wxxmlnode}) are automatically skipped if they +If {\tt flags} does not contain {\tt wxXMLDOC\_KEEP\_WHITESPACE\_NODES}, then, while loading, all nodes of +type {\tt wxXML\_TEXT\_NODE} (see \helpref{wxXmlNode}{wxxmlnode}) are automatically skipped if they contain whitespaces only. The removal of these nodes makes the load process slightly faster and requires less memory however makes impossible to recreate exactly the loaded text with a \helpref{Save}{wxxmldocumentsave} call later. @@ -179,7 +179,7 @@ Read the initial description of this class for more info. Returns \true on success, \false otherwise. -\func{bool}{Load}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC_NONE}} +\func{bool}{Load}{\param{wxInputStream\& }{stream}, \param{const wxString\& }{encoding = wxT("UTF-8")}, \param{int }{flags = wxXMLDOC\_NONE}} Like above but takes the data from given input stream. @@ -191,7 +191,7 @@ Saves XML tree creating a file named with given string. If {\tt indentstep} is greater than or equal to zero, then, while saving, an automatic indentation is added with steps composed by {\tt indentstep} spaces. -If {\tt indentstep} is {\tt wxXML_NO_INDENTATION}, then, automatic indentation is turned off. +If {\tt indentstep} is {\tt wxXML\_NO\_INDENTATION}, then, automatic indentation is turned off. \constfunc{bool}{Save}{\param{wxOutputStream\& }{stream}, \param{int }{indentstep = 1}} -- 2.45.2