X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ebb396715d5ecd865a225fa3cf7675277ceb3f1b..d30ff492f0ee23d067e996c0a5f769e4dafb0225:/docs/latex/wx/filename.tex?ds=sidebyside

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index 2093b783a0..6ef816952b 100644
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -407,7 +407,7 @@ method.
 
 Get the string containing all the path separators for this format. For all
 formats but {\tt wxPATH\_DOS} this string contains only one character but for
-DOS and Windows both {\tt '/'} and {\tt '\backslash'} may be used as
+DOS and Windows both {\tt '/'} and {\tt '\textbackslash'} may be used as
 separators.
 
 \wxheading{See also}
@@ -647,12 +647,21 @@ set the file creation and last access/mod times
 
 \membersection{wxFileName::SplitPath}\label{wxfilenamesplitpath}
 
-\func{void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{volume}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
-\func{void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
+\func{static void}{SplitPath}{\param{const wxString\& }{fullpath}, \param{wxString* }{path}, \param{wxString* }{name}, \param{wxString* }{ext}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
-split a fullpath into the volume, path, (base) name and extension
-(all of the pointers can be NULL)
+This function splits a full file name into components: the volume (with the
+first version) path (including the volume in the second version), the base name
+and the extension. Any of the output parameters ({\it volume}, {\it path}, 
+{\it name} or {\it ext}) may be {\tt NULL} if you are not interested in the
+value of a particular component. Also, {\it fullpath} may be empty on entry.
+
+On return, {\it path} contains the file path (without the trailing separator), 
+{\it name} contains the file name and {\it ext} contains the file extension
+without leading dot. All three of them may be empty if the corresponding
+component is. The old contents of the strings pointed to by these parameters
+will be overwritten in any case (if the pointers are not {\tt NULL}).
 
 \membersection{wxFileName::Touch}\label{wxfilenametouch}
 
