Split wxDataViewVirtualModel fork wxDataViewIndexModel to make the code clearer and...

[wxWidgets.git] / interface / regex.h

diff --git a/interface/regex.h b/interface/regex.h
index ae5d69eb269ef85ce279905bd45dcb1483c3cfc9..68db15b112d93501f8a5970812bd28c36801a131 100644 (file)
--- a/interface/regex.h
+++ b/interface/regex.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        regex.h
-// Purpose:     documentation for wxRegEx class
+// Purpose:     interface of wxRegEx
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -21,7 +21,7 @@
 
     Regular expressions, as defined by POSIX, come in two flavours: @e extended
     and @e basic.  The builtin library also adds a third flavour
-    of expression advanced, which is not available
+    of expression advanced(), which is not available
     when using the system library.
 
     Unicode is fully supported only when using the builtin library.
@@ -37,8 +37,7 @@
     @library{wxbase}
     @category{data}
 
-    @seealso
-    wxRegEx::ReplaceFirst
+    @see wxRegEx::ReplaceFirst
 */
 class wxRegEx
 {
@@ -65,84 +64,79 @@ public:
 
     //@{
     /**
-        Returns the part of string corresponding to the match where @e index is
+        Returns the part of string corresponding to the match where @a index is
         interpreted as above. Empty string is returned if match failed
-        
         May only be called after successful call to Matches()
         and only if @c wxRE_NOSUB was @b not used in
         Compile().
     */
-    bool GetMatch(size_t* start, size_t* len, size_t index = 0);
-    not wxString  GetMatch(const wxString& text,
-                           size_t index = 0);
+    bool GetMatch(size_t* start, size_t* len, size_t index = 0) const;
+    const not used in
+    Compile().
+    Returns false if no match or if an error occurred.
+        wxString  GetMatch(const wxString& text, size_t index = 0) const;
     //@}
 
     /**
         Returns the size of the array of matches, i.e. the number of bracketed
         subexpressions plus one for the expression itself, or 0 on error.
-        
         May only be called after successful call to Compile().
         and only if @c wxRE_NOSUB was @b not used.
     */
-    size_t GetMatchCount();
+    size_t GetMatchCount() const;
 
     /**
         Return @true if this is a valid compiled regular expression, @false
         otherwise.
     */
-    bool IsValid();
+    bool IsValid() const;
 
     //@{
     /**
         Matches the precompiled regular expression against the string @e text,
         returns @true if matches and @false otherwise.
-        
         @e Flags may be combination of @c wxRE_NOTBOL and @c wxRE_NOTEOL.
-        
         Some regex libraries assume that the text given is null terminated, while
         others require the length be given as a separate parameter. Therefore for
-        maximum portability assume that @e text cannot contain embedded nulls.
-        
+        maximum portability assume that @a text cannot contain embedded nulls.
         When the @e Matches(const wxChar *text, int flags = 0) form is used,
         a @e wxStrlen() will be done internally if the regex library requires the
         length. When using @e Matches() in a loop
         the @e Matches(text, flags, len) form can be used instead, making it
         possible to avoid a @e wxStrlen() inside the loop.
-        
         May only be called after successful call to Compile().
     */
-    bool Matches(const wxChar* text, int flags = 0);
-    bool Matches(const wxChar* text, int flags, size_t len);
-    bool Matches(const wxString& text, int flags = 0);
+    bool Matches(const wxChar* text, int flags = 0) const;
+    const bool Matches(const wxChar* text, int flags, size_t len) const;
+    const bool Matches(const wxString& text, int flags = 0) const;
     //@}
 
     /**
         Replaces the current regular expression in the string pointed to by
-        @e text, with the text in @e replacement and return number of matches
+        @e text, with the text in @a replacement and return number of matches
         replaced (maybe 0 if none found) or -1 on error.
-        
         The replacement text may contain back references @c \number which will be
         replaced with the value of the corresponding subexpression in the
         pattern match. @c \0 corresponds to the entire match and @c  is a
         synonym for it. Backslash may be used to quote itself or @c  character.
-        
-        @e maxMatches may be used to limit the number of replacements made, setting
+        @a maxMatches may be used to limit the number of replacements made, setting
         it to 1, for example, will only replace first occurrence (if any) of the
         pattern in the text while default value of 0 means replace all.
     */
     int Replace(wxString* text, const wxString& replacement,
-                size_t maxMatches = 0);
+                size_t maxMatches = 0) const;
 
     /**
         Replace all occurrences: this is actually a synonym for
         Replace().
-        
-        @sa ReplaceFirst()
+
+        @see ReplaceFirst()
     */
-    int ReplaceAll(wxString* text, const wxString& replacement);
+    int ReplaceAll(wxString* text, const wxString& replacement) const;
 
     /**
         Replace the first occurrence.
     */
-    int ReplaceFirst(wxString* text, const wxString& replacement);
+    int ReplaceFirst(wxString* text, const wxString& replacement) const;
 };
+