mention that Wait() relocks the mutex before returning (patch 1482390)

[wxWidgets.git] / docs / latex / wx / regex.tex

diff --git a/docs/latex/wx/regex.tex b/docs/latex/wx/regex.tex
index 58687c9934aca2fd17f1deb67240df238987f7d5..27c4928c74d152d105b4abda00e724f9f1fe5021 100644 (file)
--- a/docs/latex/wx/regex.tex
+++ b/docs/latex/wx/regex.tex
@@ -197,12 +197,15 @@ returns {\tt true} if matches and {\tt false} otherwise.
 
 {\it Flags} may be combination of {\tt wxRE\_NOTBOL} and {\tt wxRE\_NOTEOL}.
 
-System regex libraries always assume the text being searched is null
-terminated and any length given is ignored.
-
-When using the built-in regex library, the first overload obtains the length
-of the string using wxStrlen, the second from the {\it len} parameter and the
-third from the length of the {\it wxString}.
+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 {\it text} cannot contain embedded nulls.
+
+When the {\it Matches(const wxChar *text, int flags = 0)} form is used,
+a {\it wxStrlen()} will be done internally if the regex library requires the
+length. When using {\it Matches()} in a loop
+the {\it Matches(text, flags, len)} form can be used instead, making it
+possible to avoid a {\it wxStrlen()} inside the loop.
 
 May only be called after successful call to \helpref{Compile()}{wxregexcompile}.