From 0cc860a2abfc35e514119806147cc0b03706d4a8 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Fri, 20 Mar 2009 12:17:45 +0000 Subject: [PATCH] add group file for locale functions (was part of r59627) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59643 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/groups/funcmacro_locale.h | 29 ++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/doxygen/groups/funcmacro_locale.h diff --git a/docs/doxygen/groups/funcmacro_locale.h b/docs/doxygen/groups/funcmacro_locale.h new file mode 100644 index 0000000000..d8e5c23b6d --- /dev/null +++ b/docs/doxygen/groups/funcmacro_locale.h @@ -0,0 +1,29 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: funcmacro_locale.h +// Purpose: wxXLocale-enabled functions +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** + +@defgroup group_funcmacro_locale Locale-dependent functions +@ingroup group_funcmacro + +Below are a number of functions/macros which accept as last parameter a +specific wxXLocale instance. + +For the documentation of function @c wxFunc_l(), please see the documentation +of the standard @c Func() function (see e.g. http://www.cppreference.com/wiki/c/string/start) +and keep in mind that the wxWidgets function takes as last parameter the +locale which should be internally used for locale-dependent operations. + +Last, note that when the @c wxHAS_XLOCALE_SUPPORT symbol is not defined, +then wxWidgets will provide implementations of these functions itself +and that they are not granted to be thread-safe (and they will work only with the +C locale; see @ref xlocale_avail). + + +*/ +