Better documentation for the default parameters values.

Use symbolic names for them and document them separately.

Closes #14051.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70791 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-03-04 00:29:07 +00:00
parent 3285e9a347
commit 0b59366faa
6 changed files with 104 additions and 43 deletions

View File

@@ -59,6 +59,9 @@ enum wxStringTokenizerMode
wxTOKEN_STRTOK
};
/// Default wxStringTokenizer delimiters are the usual white space characters.
#define wxDEFAULT_DELIMITERS " \t\r\n"
/**
@class wxStringTokenizer
@@ -106,7 +109,7 @@ public:
@see SetString()
*/
wxStringTokenizer(const wxString& str,
const wxString& delims = " \t\r\n",
const wxString& delims = wxDEFAULT_DELIMITERS,
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
/**
@@ -154,8 +157,8 @@ public:
containing delimiters, and the @a mode specifying how the string
should be tokenized.
*/
void SetString(const wxString& to_tokenize,
const wxString& delims = " \t\r\n",
void SetString(const wxString& str,
const wxString& delims = wxDEFAULT_DELIMITERS,
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
};
@@ -178,5 +181,5 @@ wxArrayString
wxStringTokenize(const wxString& str,
const wxString& delims = wxDEFAULT_DELIMITERS,
wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
//@}