Intial review of calctrl.h.

[wxWidgets.git] / interface / tokenzr.h

diff --git a/interface/tokenzr.h b/interface/tokenzr.h
index 6250d27dc065161fa887f069995e395bfe195915..b9db6a1826c7d5a428e8eb06785ad2650bea6c6c 100644 (file)
--- a/interface/tokenzr.h
+++ b/interface/tokenzr.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tokenzr.h
-// Purpose:     documentation for wxStringTokenizer class
+// Purpose:     interface of wxStringTokenizer
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -61,7 +61,7 @@
 
     In this mode, the empty tokens in the
     middle of the string will be returned, i.e. @c "a::b:" will be tokenized in
-    three tokens 'a', '' and 'b'. Notice that all trailing delimiters are ignored
+    three tokens 'a', " and 'b'. Notice that all trailing delimiters are ignored
     in this mode, not just the last one, i.e. a string @c "a::b::" would
     still result in the same set of tokens.
 
@@ -99,8 +99,7 @@
     @library{wxbase}
     @category{data}
 
-    @seealso
-    wxStringTokenize
+    @see wxStringTokenize()
 */
 class wxStringTokenizer : public wxObject
 {
@@ -123,38 +122,39 @@ public:
         reaches 0 HasMoreTokens() returns
         @false.
     */
-    int CountTokens();
+    int CountTokens() const;
 
     /**
         Returns the delimiter which ended scan for the last token returned by
         GetNextToken() or @c NUL if
         there had been no calls to this function yet or if it returned the trailing
         empty token in @c wxTOKEN_RET_EMPTY_ALL mode.
-        This function is new since wxWidgets version 2.7.0
+
+        @wxsince{2.7.0}
     */
     wxChar GetLastDelimiter();
 
     /**
         Returns the next token or empty string if the end of string was reached.
     */
-    wxString GetNextToken();
+    wxString GetNextToken() const;
 
     /**
         Returns the current position (i.e. one index after the last returned
         token or 0 if GetNextToken() has never been called) in the original
         string.
     */
-    size_t GetPosition();
+    size_t GetPosition() const;
 
     /**
         Returns the part of the starting string without all token already extracted.
     */
-    wxString GetString();
+    wxString GetString() const;
 
     /**
         Returns @true if the tokenizer has further tokens, @false if none are left.
     */
-    bool HasMoreTokens();
+    bool HasMoreTokens() const;
 
     /**
         Initializes the tokenizer.
@@ -165,3 +165,4 @@ public:
                    const wxString& delims = " \t\r\n",
                    wxStringTokenizerMode mode = wxTOKEN_DEFAULT);
 };
+