fix many doxygen warnings about undocumented parameters

[wxWidgets.git] / interface / wx / string.h

diff --git a/interface/wx/string.h b/interface/wx/string.h
index b6cf403dc8d5a5a140ac3b1f8833cff599c29447..dd0c7d7d2e3408623c10948cf65ed5ac6355f926 100644 (file)
--- a/interface/wx/string.h
+++ b/interface/wx/string.h
@@ -27,10 +27,10 @@
     @endcode
 
     Note that the exact usage of this depends on whether or not wxUSE_STL is
     @endcode
 
     Note that the exact usage of this depends on whether or not wxUSE_STL is

-    enabled. If wxUSE_STL is enabled, wxStringBuffer creates a separate empty 
+    enabled. If wxUSE_STL is enabled, wxStringBuffer creates a separate empty

     character buffer, and if wxUSE_STL is disabled, it uses GetWriteBuf() from
     character buffer, and if wxUSE_STL is disabled, it uses GetWriteBuf() from

-    wxString, keeping the same buffer wxString uses intact. In other words, 
-    relying on wxStringBuffer containing the old wxString data is not a good 
+    wxString, keeping the same buffer wxString uses intact. In other words,
+    relying on wxStringBuffer containing the old wxString data is not a good

     idea if you want to build your program both with and without wxUSE_STL.
 
     @library{wxbase}
     idea if you want to build your program both with and without wxUSE_STL.
 
     @library{wxbase}


@@ -65,25 +65,41 @@ public:
 /**
     @class wxString
 
 /**
     @class wxString
 

+    The wxString class has been completely rewritten for wxWidgets 3.0
+    and this change was actually the main reason for the calling that
+    version wxWidgets 3.0.
+

     wxString is a class representing a Unicode character string.
     wxString uses @c std::string internally to store its content
     unless this is not supported by the compiler or disabled
     wxString is a class representing a Unicode character string.
     wxString uses @c std::string internally to store its content
     unless this is not supported by the compiler or disabled

-    specifically when building wxWidgets. Therefore wxString
-    inherits many features from @c std::string. Most
-    implementations of @c std::string are thread-safe and don't
-    use reference counting. By default, wxString uses @c std::string
-    internally even if wxUSE_STL is not defined.
-
-    Since wxWidgets 3.0 wxString internally uses UCS-2 (basically 2-byte per
-    character wchar_t and nearly the same as UTF-16) under Windows and 
-    UTF-8 under Unix, Linux and OS X to store its content. 
+    specifically when building wxWidgets and it therefore inherits
+    many features from @c std::string. Most implementations of
+    @c std::string are thread-safe and don't use reference counting.
+    By default, wxString uses @c std::string internally even if
+    wxUSE_STL is not defined.
+
+    wxString now internally uses UTF-16 under Windows and UTF-8 under
+    Unix, Linux and OS X to store its content. Note that when iterating
+    over a UTF-16 string under Windows, the user code has to take care
+    of surrogate pair handling whereas Windows itself has built-in
+    support pairs in UTF-16, such as for drawing strings on screen.
+    

     Much work has been done to make existing code using ANSI string literals
     Much work has been done to make existing code using ANSI string literals

-    work as before. If you need to have a wxString that uses wchar_t on Unix
-    and Linux, too, you can specify this on the command line with the
-    @c configure @c --disable-utf8 switch.
+    work as before. If you nonetheless need to have a wxString that uses wchar_t
+    on Unix and Linux, too, you can specify this on the command line with the
+    @c configure @c --disable-utf8 switch or you can consider using wxUString
+    or std::wstring instead.
+
+    Accessing a UTF-8 string by index can be very inefficient because
+    a single character is represented by a variable number of bytes so that
+    the entire string has to be parsed in order to find the character.
+    Since iterating over a string by index is a common programming technique and
+    was also possible and encouraged by wxString using the access operator[]()
+    wxString implements caching of the last used index so that iterating over
+    a string is a linear operation even in UTF-8 mode.

     
     

-    Since iterating over a wxString by index can become inefficient in UTF-8
-    mode and iterators should be used instead of index based access:
+    It is nonetheless recommended to use iterators (instead of index based
+    access) like this:

 
     @code
     wxString s = "hello";
 
     @code
     wxString s = "hello";


@@ -120,6 +136,8 @@ public:
     append something to a C string (including literal constants), so to do this it
     should be converted to a wxString first.
 
     append something to a C string (including literal constants), so to do this it
     should be converted to a wxString first.
 

+        @li insert()
+        @li append()

         @li operator<<()
         @li operator+=()
         @li operator+()
         @li operator<<()
         @li operator+=()
         @li operator+()


@@ -134,6 +152,7 @@ public:
         @li wxString()
         @li operator=()
         @li ~wxString()
         @li wxString()
         @li operator=()
         @li ~wxString()

+        @li assign()

 
         The MakeXXX() variants modify the string in place, while the other functions
         return a new string which contains the original text converted to the upper or
 
         The MakeXXX() variants modify the string in place, while the other functions
         return a new string which contains the original text converted to the upper or


@@ -143,6 +162,8 @@ public:
         @li Upper()
         @li MakeLower()
         @li Lower()
         @li Upper()
         @li MakeLower()
         @li Lower()

+        @li MakeCapitalized()
+        @li Capitalize()

 
         Many functions below take a character index in the string. As with C
         strings and arrays, the indices start from 0, so the first character of a
 
         Many functions below take a character index in the string. As with C
         strings and arrays, the indices start from 0, so the first character of a


@@ -151,7 +172,7 @@ public:
         failure in @ref overview_debugging "debug build", but no checks are
         done in release builds.
         This section also contains both implicit and explicit conversions to C style
         failure in @ref overview_debugging "debug build", but no checks are
         done in release builds.
         This section also contains both implicit and explicit conversions to C style

-        strings. Although implicit conversion is quite convenient, you are advised 
+        strings. Although implicit conversion is quite convenient, you are advised

         to use wc_str() for the sake of clarity.
 
         @li GetChar()
         to use wc_str() for the sake of clarity.
 
         @li GetChar()


@@ -166,10 +187,9 @@ public:
         @li mb_str()
         @li fn_str()
 
         @li mb_str()
         @li fn_str()
 

-        The default comparison function Cmp() is case-sensitive and
-        so is the default version of IsSameAs(). For case
-        insensitive comparisons you should use CmpNoCase() or
-        give a second parameter to IsSameAs. This last function is may be more
+        The default comparison function Cmp() is case-sensitive and so is the default
+        version of IsSameAs(). For case insensitive comparisons you should use CmpNoCase()
+        or give a second parameter to IsSameAs(). This last function is maybe more

         convenient if only equality of the strings matters because it returns a boolean
         @true value if the strings are the same and not 0 (which is usually @false
         in C) as Cmp() does.
         convenient if only equality of the strings matters because it returns a boolean
         @true value if the strings are the same and not 0 (which is usually @false
         in C) as Cmp() does.


@@ -179,6 +199,7 @@ public:
         with some predefined prefix and is more efficient than doing direct string
         comparison as you would also have to precalculate the length of the prefix.
 
         with some predefined prefix and is more efficient than doing direct string
         comparison as you would also have to precalculate the length of the prefix.
 

+        @li compare()

         @li Cmp()
         @li CmpNoCase()
         @li IsSameAs()
         @li Cmp()
         @li CmpNoCase()
         @li IsSameAs()


@@ -203,6 +224,8 @@ public:
         when working with some external API which requires the caller to provide
         a writable buffer.
 
         when working with some external API which requires the caller to provide
         a writable buffer.
 

+        @li reserve()
+        @li resize()

         @li Alloc()
         @li Shrink()
         @li wxStringBuffer
         @li Alloc()
         @li Shrink()
         @li wxStringBuffer


@@ -217,16 +240,19 @@ public:
         These functions return the string length and check whether the string
         is empty or they empty it.
 
         These functions return the string length and check whether the string
         is empty or they empty it.
 

+        @li length()
+        @li size()

         @li Len()
         @li IsEmpty()
         @li operator!()
         @li Empty()
         @li Clear()
 
         @li Len()
         @li IsEmpty()
         @li operator!()
         @li Empty()
         @li Clear()
 

-        These functions allow you to extract a substring from the string. The 
+        These functions allow you to extract a substring from the string. The

         original string is not modified and the function returns the extracted
         substring.
 
         original string is not modified and the function returns the extracted
         substring.
 

+        @li substr()

         @li Mid()
         @li operator()()
         @li Left()
         @li Mid()
         @li operator()()
         @li Left()


@@ -241,6 +267,9 @@ public:
         These functions replace the standard @e strchr() and @e strstr()
         functions.
 
         These functions replace the standard @e strchr() and @e strstr()
         functions.
 

+        @li find()
+        @li rfind()
+        @li replace()

         @li Find()
         @li Replace()
 
         @li Find()
         @li Replace()
 


@@ -268,7 +297,7 @@ public:
     ::Objects, ::wxEmptyString,
 
     @see @ref overview_string "wxString overview", @ref overview_unicode
     ::Objects, ::wxEmptyString,
 
     @see @ref overview_string "wxString overview", @ref overview_unicode

-    "Unicode overview"
+    "Unicode overview", wxUString

 */
 class wxString
 {
 */
 class wxString
 {


@@ -430,7 +459,7 @@ public:
     /**
        Appends the string literal @e psz with max length @e nLen.
     */
     /**
        Appends the string literal @e psz with max length @e nLen.
     */

-    wxString& Append(const char* psz, size_t nLen);
+    wxString& Append(const wchar_t* pwz);

 
     /**
        Appends the wide string literal @e psz with max length @e nLen.
 
     /**
        Appends the wide string literal @e psz with max length @e nLen.


@@ -440,7 +469,7 @@ public:
     /**
        Appends the string @e s.
     */
     /**
        Appends the string @e s.
     */

-    wxString &Append(const wxString &s);
+    wxString& Append(const wchar_t* pwz, size_t nLen);

 
     /**
        Appends the character @e ch @e count times.
 
     /**
        Appends the character @e ch @e count times.


@@ -460,6 +489,16 @@ public:
     wxString BeforeLast(wxUniChar ch) const;
 
 
     wxString BeforeLast(wxUniChar ch) const;
 
 

+    /**
+        Return the copy of the string with the first string character in the
+        upper case and the subsequent ones in the lower case.
+
+        @since 2.9.0
+
+        @see MakeCapitalized()
+     */
+    wxString Capitalize() const;
+

     /**
         Empties the string and frees memory occupied by it.
         See also: Empty()
     /**
         Empties the string and frees memory occupied by it.
         See also: Empty()


@@ -756,6 +795,8 @@ public:
 
     /**
         Returns this string converted to the lower case.
 
     /**
         Returns this string converted to the lower case.

+
+        @see MakeLower()

     */
     wxString Lower() const;
 
     */
     wxString Lower() const;
 


@@ -767,12 +808,28 @@ public:
     void LowerCase();
 
     /**
     void LowerCase();
 
     /**

-        Converts all characters to lower case and returns the result.
+        Converts the first characters of the string to the upper case and all
+        the subsequent ones to the lower case and returns the result.
+
+        @since 2.9.0
+
+        @see Capitalize()
+    */
+    wxString& MakeCapitalized();
+
+    /**
+        Converts all characters to lower case and returns the reference to the
+        modified string.
+
+        @see Lower()

     */
     wxString& MakeLower();
 
     /**
     */
     wxString& MakeLower();
 
     /**

-        Converts all characters to upper case and returns the result.
+        Converts all characters to upper case and returns the reference to the
+        modified string.
+
+        @see Upper()

     */
     wxString& MakeUpper();
 
     */
     wxString& MakeUpper();
 


@@ -1015,6 +1072,8 @@ public:
 
     /**
         Returns this string converted to upper case.
 
     /**
         Returns this string converted to upper case.

+
+        @see MakeUpper()

     */
     wxString Upper() const;
 
     */
     wxString Upper() const;
 


@@ -1030,14 +1089,14 @@ public:
         convertible to both @c const @c char* and to @c const @c wchar_t*.
         Given this ambiguity it is mostly better to use wc_str(), mb_str() or
         utf8_str() instead.
         convertible to both @c const @c char* and to @c const @c wchar_t*.
         Given this ambiguity it is mostly better to use wc_str(), mb_str() or
         utf8_str() instead.

-        
+

         Please see the @ref overview_unicode "Unicode overview" for more
         information about it.
         Please see the @ref overview_unicode "Unicode overview" for more
         information about it.

-        
+

         Note that the returned value is not convertible to @c char* or
         @c wchar_t*, use char_str() or wchar_str() if you need to pass
         string value to a function expecting non-const pointer.
         Note that the returned value is not convertible to @c char* or
         @c wchar_t*, use char_str() or wchar_str() if you need to pass
         string value to a function expecting non-const pointer.

-        
+

         @see wc_str(), utf8_str(), c_str(), mb_str(), fn_str()
     */
     const wxCStrData c_str() const;
         @see wc_str(), utf8_str(), c_str(), mb_str(), fn_str()
     */
     const wxCStrData c_str() const;


@@ -1088,8 +1147,8 @@ public:
 
     /**
         Returns the multibyte (C string) representation of the string
 
     /**
         Returns the multibyte (C string) representation of the string

-        using @e conv's wxMBConv::cWC2MB method and returns wxCharBuffer. 
-        
+        using @e conv's wxMBConv::cWC2MB method and returns wxCharBuffer.
+

         @see wc_str(), utf8_str(), c_str(), wxMBConv
     */
     const wxCharBuffer mb_str(const wxMBConv& conv = wxConvLibc) const;
         @see wc_str(), utf8_str(), c_str(), wxMBConv
     */
     const wxCharBuffer mb_str(const wxMBConv& conv = wxConvLibc) const;


@@ -1108,14 +1167,14 @@ public:
     wxString& operator<<(const char* psz)
     wxString& operator<<(const wchar_t* pwz)
     wxString& operator<<(const wxCStrData& psz)
     wxString& operator<<(const char* psz)
     wxString& operator<<(const wchar_t* pwz)
     wxString& operator<<(const wxCStrData& psz)

-    wxString& operator<<(wxUniChar ch);
+    wxString& operator<<(const char* psz);

     wxString& operator<<(wxUniCharRef ch)
     wxString& operator<<(char ch)
     wxString& operator<<(unsigned char ch)
     wxString& operator<<(wchar_t ch)
     wxString& operator<<(const wxCharBuffer& s)
     wxString& operator<<(const wxWCharBuffer& s)
     wxString& operator<<(wxUniCharRef ch)
     wxString& operator<<(char ch)
     wxString& operator<<(unsigned char ch)
     wxString& operator<<(wchar_t ch)
     wxString& operator<<(const wxCharBuffer& s)
     wxString& operator<<(const wxWCharBuffer& s)

-    wxString& operator<<(int i);
+    wxString& operator<<(wxUniCharRef ch);

     wxString& operator<<(unsigned int ui);
     wxString& operator<<(long l);
     wxString& operator<<(unsigned long ul);
     wxString& operator<<(unsigned int ui);
     wxString& operator<<(long l);
     wxString& operator<<(unsigned long ul);


@@ -1177,7 +1236,7 @@ public:
         Converts the strings contents to UTF-8 and returns it either as a
         temporary wxCharBuffer object or as a pointer to the internal
         string contents in UTF-8 build.
         Converts the strings contents to UTF-8 and returns it either as a
         temporary wxCharBuffer object or as a pointer to the internal
         string contents in UTF-8 build.

-        
+

         @see wc_str(), c_str(), mb_str()
     */
     const char* utf8_str() const;
         @see wc_str(), c_str(), mb_str()
     */
     const char* utf8_str() const;


@@ -1187,7 +1246,7 @@ public:
     //@{
     /**
         Converts the strings contents to the wide character represention
     //@{
     /**
         Converts the strings contents to the wide character represention

-        and returns it as a temporary wxWCharBuffer object (Unix and OS X) 
+        and returns it as a temporary wxWCharBuffer object (Unix and OS X)

         or returns a pointer to the internal string contents in wide character
         mode (Windows).
 
         or returns a pointer to the internal string contents in wide character
         mode (Windows).
 


@@ -1211,7 +1270,7 @@ public:
     */
     wxWritableWCharBuffer wchar_str() const;
 
     */
     wxWritableWCharBuffer wchar_str() const;
 

-    /** 
+    /**

        Explicit conversion to C string in the internal representation (either
        wchar_t* or UTF-8-encoded char*, depending on the build).
     */
        Explicit conversion to C string in the internal representation (either
        wchar_t* or UTF-8-encoded char*, depending on the build).
     */


@@ -1370,10 +1429,10 @@ wxString wxEmptyString;
     @endcode
 
     Note that the exact usage of this depends on whether or not wxUSE_STL is
     @endcode
 
     Note that the exact usage of this depends on whether or not wxUSE_STL is

-    enabled. If wxUSE_STL is enabled, wxStringBuffer creates a separate empty 
+    enabled. If wxUSE_STL is enabled, wxStringBuffer creates a separate empty

     character buffer, and if wxUSE_STL is disabled, it uses GetWriteBuf() from
     character buffer, and if wxUSE_STL is disabled, it uses GetWriteBuf() from

-    wxString, keeping the same buffer wxString uses intact. In other words, 
-    relying on wxStringBuffer containing the old wxString data is not a good 
+    wxString, keeping the same buffer wxString uses intact. In other words,
+    relying on wxStringBuffer containing the old wxString data is not a good

     idea if you want to build your program both with and without wxUSE_STL.
 
     Note that SetLength @c must be called before wxStringBufferLength destructs.
     idea if you want to build your program both with and without wxUSE_STL.
 
     Note that SetLength @c must be called before wxStringBufferLength destructs.