X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..4104ed92a537f36f7f41ce07d34cadbe4d78685c:/docs/latex/wx/wxstring.tex

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index a77d3324f7..b81b116412 100644
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -8,6 +8,14 @@ These standard functions are not documented in this manual so please see the STL
 The behaviour of all these functions is identical to the behaviour described
 there.
 
+You may notice that wxString sometimes has many functions which do the same
+thing like, for example, \helpref{Length()}{wxstringlength}, 
+\helpref{Len()}{wxstringlen} and {\tt length()} which all return the string
+length. In all cases of such duplication the {\tt std::string}-compatible
+method ({\tt length()} in this case, always the lowercase version) should be
+used as it will ensure smoother transition to {\tt std::string} when wxWindows
+starts using it instead of wxString.
+
 \wxheading{Derived from}
 
 None
@@ -577,15 +585,13 @@ Searches for the given string. Returns the starting index, or -1 if not found.
 
 \membersection{wxString::First}\label{wxstringfirst}
 
-\func{size\_t}{First}{\param{char}{ c}}
-
-\constfunc{size\_t}{First}{\param{const char*}{ psz}}
+\func{int}{First}{\param{char}{ c}}
 
-\constfunc{size\_t}{First}{\param{const wxString\&}{ str}}
+\constfunc{int}{First}{\param{const char*}{ psz}}
 
-\constfunc{size\_t}{First}{\param{const char}{ ch}}
+\constfunc{int}{First}{\param{const wxString\&}{ str}}
 
-Returns the first occurrence of the item.
+Same as \helpref{Find}{wxstringfind}.
 
 \membersection{wxString::Format}\label{wxstringformat}
 
@@ -635,9 +641,11 @@ Returns a reference to the character at position {\it n}.
 
 \membersection{wxString::GetWriteBuf}\label{wxstringgetwritebuf}
 
-\func{char*}{GetWriteBuf}{\param{size\_t}{ len}}
+\func{wxChar*}{GetWriteBuf}{\param{size\_t}{ len}}
 
 Returns a writable buffer of at least {\it len} bytes.
+It returns a pointer to a new memory block, and the
+existing data will not be copied.
 
 Call \helpref{wxString::UngetWriteBuf}{wxstringungetwritebuf} as soon as possible
 to put the string back into a reasonable state.
@@ -646,8 +654,6 @@ to put the string back into a reasonable state.
 
 \constfunc{size\_t}{Index}{\param{char}{ ch}}
 
-Same as \helpref{wxString::Find}{wxstringfind}.
-
 \constfunc{size\_t}{Index}{\param{const char*}{ sz}}
 
 Same as \helpref{wxString::Find}{wxstringfind}.
@@ -764,15 +770,15 @@ Same as MakeLower.
 
 \membersection{wxString::MakeLower}\label{wxstringmakelower}
 
-\func{void}{MakeLower}{\void}
+\func{wxString\&}{MakeLower}{\void}
 
-Converts all characters to lower case.
+Converts all characters to lower case and returns the result.
 
 \membersection{wxString::MakeUpper}\label{wxstringmakeupper}
 
-\func{void}{MakeUpper}{\void}
+\func{wxString\&}{MakeUpper}{\void}
 
-Converts all characters to upper case.
+Converts all characters to upper case and returns the result.
 
 \membersection{wxString::Matches}\label{wxstringmatches}