add docs for the global wxStringTokenize() function which were lost during latex=>doxygen conversion

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64406 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi 2010-05-26 23:05:04 +00:00
parent 363daf0bd1
commit c631ad5452

View File

@ -88,7 +88,7 @@ enum wxStringTokenizerMode
@library{wxbase}
@category{data}
@see wxStringTokenize()
@see ::wxStringTokenize()
*/
class wxStringTokenizer : public wxObject
{
@ -158,3 +158,25 @@ public:
const wxString& delims = " \t\r\n",
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
};
/** @addtogroup group_funcmacro_string */
//@{
/**
This is a convenience function wrapping wxStringTokenizer which simply
returns all tokens found in the given @a str as an array.
Please see wxStringTokenizer::wxStringTokenizer for the description
of the other parameters.
@return The array with the parsed tokens.
@header{wx/string.h}
*/
wxArrayString
wxStringTokenize(const wxString& str,
const wxString& delims = wxDEFAULT_DELIMITERS,
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
//@}