X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..82bf63a08ca2c5e2d500557550449cad219991c9:/interface/cpp.h diff --git a/interface/cpp.h b/interface/cpp.h index 3b3140ab52..b8585c519c 100644 --- a/interface/cpp.h +++ b/interface/cpp.h @@ -1,40 +1,52 @@ ///////////////////////////////////////////////////////////////////////////// - // Name: cpp.h - // Purpose: documentation for global functions - // Author: wxWidgets team - // RCS-ID: $Id$ - // Licence: wxWindows license - ///////////////////////////////////////////////////////////////////////////// - - //@{ +// Name: cpp.h +// Purpose: interface of global functions +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + + +/** @ingroup group_funcmacro_misc */ +//@{ /** - These macro return the concatenation of the tokens passed as their arguments. - Unlike when using the preprocessor @c operator, the arguments undergo - the macro expansion before being concatenated. + This macro returns the concatenation of the arguments passed. Unlike when + using the preprocessor operator, the arguments undergo macro expansion + before being concatenated. + + @header{wx/cpp.h} */ - wxCONCAT(x1, x2); - wxCONCAT3(x1, x2, x3); - wxCONCAT4(x1, x2, x3, x4); - wxCONCAT5(x1, x2, x3, x4, x5); +#define wxCONCAT(x1, x2) +#define wxCONCAT3(x1, x2, x3) +#define wxCONCAT4(x1, x2, x3, x4) +#define wxCONCAT5(x1, x2, x3, x4, x5) //@} +/** @ingroup group_funcmacro_misc */ +//@{ - /** +/** Returns the string representation of the given symbol which can be either a literal or a macro (hence the advantage of using this macro instead of the standard preprocessor @c # operator which doesn't work with macros). - - Notice that this macro always produces a @c char string, use - wxSTRINGIZE_T to build a wide string Unicode build. - - @sa wxCONCAT + + Notice that this macro always produces a @c char string, use + wxSTRINGIZE_T() to build a wide string Unicode build. + + @see wxCONCAT() + + @header{wx/cpp.h} */ -#define wxSTRINGIZE(x) /* implementation is private */ +#define wxSTRINGIZE(x) /** Returns the string representation of the given symbol as either an ASCII or - Unicode string, depending on the current build. This is the Unicode-friendly - equivalent of wxSTRINGIZE. + Unicode string, depending on the current build. This is the + Unicode-friendly equivalent of wxSTRINGIZE(). + + @header{wx/cpp.h} */ -#define wxSTRINGIZE_T(x) /* implementation is private */ +#define wxSTRINGIZE_T(x) + +//@}