Removed some inappropriate use of verbatim

[wxWidgets.git] / docs / latex / wx / filename.tex

diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index 2093b783a0cb070d828d8da7839469b7489106db..4f656c7403284c8aedd1fddfb06b7a2c01fc0f7f 100644 (file)
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -71,7 +71,7 @@ enum wxPathNormalize
 
 wxFileName currently supports the file names in the Unix, DOS/Windows, Mac OS
 and VMS formats. Although these formats are quite different, wxFileName tries
-to treat them all in the sam generic way. It supposes that all file names
+to treat them all in the same generic way. It supposes that all file names
 consist of the following parts: the volume (also known as drive under Windows
 or device under VMS), the path which is a sequence of directory names separated
 by the \helpref{path separators}{wxfilenamegetpathseparators} and the full
@@ -169,7 +169,7 @@ Copy constructor.
 \func{}{wxFileName}{\param{const wxString\& }{fullpath}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
 
 From a full filename: if it terminates with a '/', a directory path
-is contructed (the name will be empty), otherwise a file name and
+is constructed (the name will be empty), otherwise a file name and
 extension are extracted from it
 
 \func{}{wxFileName}{\param{const wxString\& }{path}, \param{const wxString\& }{name}, \param{wxPathFormat }{format = wxPATH\_NATIVE}}
@@ -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}