From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Sun, 2 Feb 2003 22:21:28 +0000 (+0000)
Subject: fixed First() signatures
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/0aa35d19622604165d6e3b985899e59dafe08094

fixed First() signatures


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@19086 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index a77d3324f7..42e6044b13 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}
 
@@ -646,8 +652,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}.