[ 1573138 ] small docs corrections

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

diff --git a/docs/latex/wx/clrpicker.tex b/docs/latex/wx/clrpicker.tex
index a6d349e46d5f30f2df3d0498fbdbdeb3b84f1468..017fca0e3ecbbba74b6a77c1d6359428db9b0b96 100644 (file)
--- a/docs/latex/wx/clrpicker.tex
+++ b/docs/latex/wx/clrpicker.tex
@@ -32,7 +32,7 @@ It is only available if \texttt{wxUSE\_COLOURPICKERCTRL} is set to $1$ (the defa
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxCLRP\_DEFAULT}}{The default style: 0.}
+\twocolitem{\windowstyle{wxCLRP\_DEFAULT\_STYLE}}{The default style: 0.}

 \twocolitem{\windowstyle{wxCLRP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxColourPickerCtrl}{wxcolourpickerctrl}
 and which can be used by the user to specify a colour (see \helpref{SetColour}{wxcolourpickerctrlsetcolour}).
 \twocolitem{\windowstyle{wxCLRP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxColourPickerCtrl}{wxcolourpickerctrl}
 and which can be used by the user to specify a colour (see \helpref{SetColour}{wxcolourpickerctrlsetcolour}).

diff --git a/docs/latex/wx/dirpicker.tex b/docs/latex/wx/dirpicker.tex
index 89364c49f22b89d9e88b8bdb999a7a2855beefdf..67b3931ecf8e775843b43d8ecfa649e1f45d945f 100644 (file)
--- a/docs/latex/wx/dirpicker.tex
+++ b/docs/latex/wx/dirpicker.tex
@@ -119,14 +119,14 @@ all the parameters.
 
 \constfunc{wxString}{GetPath}{\void}
 
 
 \constfunc{wxString}{GetPath}{\void}
 

-Returns the currently selected directory.
+Returns the absolute path of the currently selected directory.

 
 
 \membersection{wxDirPickerCtrl::SetPath}\label{wxdirpickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{dirname}}
 
 
 
 \membersection{wxDirPickerCtrl::SetPath}\label{wxdirpickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{dirname}}
 

-Sets the currently selected directory. his must be a valid directory if
+Sets the absolute path of the currently selected directory. This must be a valid directory if

 {\tt wxDIRP\_DIR\_MUST\_EXIST} style was given.
 
 
 {\tt wxDIRP\_DIR\_MUST\_EXIST} style was given.
 
 

diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex
index 46b2a7db49822ca69fdda4d2ed18d434ce196749..ffa3e996529c3d35b7d5646e53f121b8a889efae 100644 (file)
--- a/docs/latex/wx/filepicker.tex
+++ b/docs/latex/wx/filepicker.tex
@@ -129,15 +129,15 @@ all the parameters.
 
 \constfunc{wxString}{GetPath}{\void}
 
 
 \constfunc{wxString}{GetPath}{\void}
 

-Returns the currently selected file.
+Returns the absolute path of the currently selected file.

 
 
 \membersection{wxFilePickerCtrl::SetPath}\label{wxfilepickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{filename}}
 
 
 
 \membersection{wxFilePickerCtrl::SetPath}\label{wxfilepickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{filename}}
 

-Sets the currently selected file. This must be a valid file if
-{\tt wxFLP\_FILE\_MUST\_EXIST} style was given.
+Sets the absolute path of the currently selected file. This must be a valid file if
+the {\tt wxFLP\_FILE\_MUST\_EXIST} style was given.

 
 
 
 
 
 


@@ -187,11 +187,11 @@ The constructor is not normally used by the user code.
 
 \constfunc{wxString}{GetPath}{\void}
 
 
 \constfunc{wxString}{GetPath}{\void}
 

-Retrieve the file/directory the user has just selected.
+Retrieve the absolute path of the file/directory the user has just selected.

 
 
 \membersection{wxFileDirPickerEvent::SetPath}\label{wxfiledirpickereventsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{path}}
 
 
 
 \membersection{wxFileDirPickerEvent::SetPath}\label{wxfiledirpickereventsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{path}}
 

-Set the file/directory associated with the event.
+Set the absolute path of the file/directory associated with the event.

diff --git a/docs/latex/wx/fontpicker.tex b/docs/latex/wx/fontpicker.tex
index e3a46bbc0c81f161ace47847cba161be94180948..5d446d9cf8090be2f6c36852cf756a232e305e9a 100644 (file)
--- a/docs/latex/wx/fontpicker.tex
+++ b/docs/latex/wx/fontpicker.tex
@@ -32,7 +32,7 @@ It is only available if \texttt{wxUSE\_FONTPICKERCTRL} is set to $1$ (the defaul
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxFNTP\_DEFAULT}}{The default style:
+\twocolitem{\windowstyle{wxFNTP\_DEFAULT\_STYLE}}{The default style:

 wxFNTP\_FONTDESC\_AS\_LABEL | wxFNTP\_USEFONT\_FOR\_LABEL.}
 \twocolitem{\windowstyle{wxFNTP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxFontPickerCtrl}{wxfontpickerctrl}
 wxFNTP\_FONTDESC\_AS\_LABEL | wxFNTP\_USEFONT\_FOR\_LABEL.}
 \twocolitem{\windowstyle{wxFNTP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxFontPickerCtrl}{wxfontpickerctrl}

diff --git a/docs/latex/wx/xmlnode.tex b/docs/latex/wx/xmlnode.tex
index 93e89ad363dc98cc8f3198d466340abeb8aecd5a..2e00889722d3e6bcb5ac680a980c1f389d25b7e4 100644 (file)
--- a/docs/latex/wx/xmlnode.tex
+++ b/docs/latex/wx/xmlnode.tex
@@ -246,6 +246,8 @@ documents must always produce the exact same tree regardless of the locale it ru
 Removes the given node from the children list. Returns \true if the node was found and removed
 or \false if the node could not be found.
 
 Removes the given node from the children list. Returns \true if the node was found and removed
 or \false if the node could not be found.
 

+Note that the caller is reponsible for deleting the removed node in order to avoid memory leaks.
+

 \membersection{wxXmlNode::SetChildren}\label{wxxmlnodesetchildren}
 
 \func{void}{SetChildren}{\param{wxXmlNode* }{child}}
 \membersection{wxXmlNode::SetChildren}\label{wxxmlnodesetchildren}
 
 \func{void}{SetChildren}{\param{wxXmlNode* }{child}}