From bf00c875fe74d449a42685b350a79eabfc3c4f5c Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sat, 5 Nov 2005 13:48:02 +0000
Subject: [PATCH] documented wxStringTokenize()

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@36091 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/function.tex | 32 ++++++++++++++++++++++++--------
 docs/latex/wx/tokenizr.tex |  4 ++++
 2 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index a6da0b19e4..29398496a8 100644
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -229,6 +229,7 @@ the corresponding topic.
 \helpref{wxStricmp}{wxstricmp}\\
 \helpref{wxStringEq}{wxstringeq}\\
 \helpref{wxStringMatch}{wxstringmatch}\\
+\helpref{wxStringTokenize}{wxstringtokenize}\\
 \helpref{wxStripMenuCodes}{wxstripmenucodes}\\
 \helpref{wxStrlen}{wxstrlen}\\
 \helpref{wxSysErrorCode}{wxsyserrorcode}\\
@@ -1564,6 +1565,19 @@ This function complements the standard C function {\it strcmp()} which performs
 case-sensitive comparison.
 
 
+\membersection{::wxStringEq}\label{wxstringeq}
+
+\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+
+{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
+
+A macro defined as:
+
+\begin{verbatim}
+#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+\end{verbatim}
+
+
 \membersection{::wxStringMatch}\label{wxstringmatch}
 
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
@@ -1576,17 +1590,19 @@ ignoring case if {\it exact} is false. If {\it subString} is \false,
 no substring matching is done.
 
 
-\membersection{::wxStringEq}\label{wxstringeq}
-
-\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+\membersection{::wxStringTokenize}\label{wxstringtokenize}
 
-{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
+\func{wxArrayString}{wxStringTokenize}{\param{const wxString\& }{str},\\
+  \param{const wxString\& }{delims = wxDEFAULT\_DELIMITERS},\\
+  \param{wxStringTokenizerMode }{mode = wxTOKEN\_DEFAULT}}
 
-A macro defined as:
+This is a convenience function wrapping 
+\helpref{wxStringTokenizer}{wxstringtokenizer} which simply returns all tokens
+found in the given \arg{str} in an array.
 
-\begin{verbatim}
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
-\end{verbatim}
+Please see 
+\helpref{wxStringTokenizer::wxStringTokenizer}{wxstringtokenizerwxstringtokenizer} 
+for the description of the other parameters.
 
 
 \membersection{::wxStrlen}\label{wxstrlen}
diff --git a/docs/latex/wx/tokenizr.tex b/docs/latex/wx/tokenizr.tex
index 75f8ab9e8a..19ca619642 100644
--- a/docs/latex/wx/tokenizr.tex
+++ b/docs/latex/wx/tokenizr.tex
@@ -60,6 +60,10 @@ the standard {\tt strtok()} function. The empty tokens are never returned.}
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{See also}
+
+\helpref{wxStringTokenize}{wxstringtokenize}
+
 \wxheading{Include files}
 
 <wx/tokenzr.h>
-- 
2.50.0

