X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..16c4516d934736b1a68f345f88b490ea3d0b247c:/interface/link.h diff --git a/interface/link.h b/interface/link.h index 0714f6c6d2..8bd169380e 100644 --- a/interface/link.h +++ b/interface/link.h @@ -1,34 +1,40 @@ ///////////////////////////////////////////////////////////////////////////// - // Name: link.h - // Purpose: documentation for global functions - // Author: wxWidgets team - // RCS-ID: $Id$ - // Licence: wxWindows license - ///////////////////////////////////////////////////////////////////////////// - - /** - This macro can be used in conjunction with the - wxFORCE_LINK_MODULE macro to force - the linker to include in its output a specific object file. - +// Name: link.h +// Purpose: interface of global functions +// Author: wxWidgets team +// RCS-ID: $Id$ +// Licence: wxWindows license +///////////////////////////////////////////////////////////////////////////// + +/** @ingroup group_funcmacro_byteorder */ +//@{ + +/** + This macro can be used in conjunction with the wxFORCE_LINK_MODULE() macro + to force the linker to include in its output a specific object file. + In particular, you should use this macro in the source file which you want - to force for inclusion. The @c moduleName needs to be a name not already - in use in other @c wxFORCE_LINK_THIS_MODULE macros, but is not required - to be e.g. the same name of the source file (even if it's a good choice). + to force for inclusion. The @c moduleName needs to be a name not already in + use in other wxFORCE_LINK_THIS_MODULE() macros, but is not required to be + e.g. the same name of the source file (even if it's a good choice). + + @header{wx/link.h} */ -#define wxFORCE_LINK_THIS_MODULE() /* implementation is private */ +#define wxFORCE_LINK_THIS_MODULE( moduleName ) +/** + This macro can be used in conjunction with the wxFORCE_LINK_THIS_MODULE() + macro to force the linker to include in its output a specific object file. - /** - This macro can be used in conjunction with the - wxFORCE_LINK_THIS_MODULE macro to force - the linker to include in its output a specific object file. - In particular, you should use this macro in a source file which you know - for sure is linked in the output (e.g. the source file containing the "main()" - of your app). The @c moduleName is the name of the module you want to - forcefully link - (i.e. the name you used in the relative wxFORCE_LINK_THIS_MODULE macro. + for sure is linked in the output (e.g. the source file containing the + @c main() of your app). The @c moduleName is the name of the module you + want to forcefully link (i.e. the name you used in the relative + wxFORCE_LINK_THIS_MODULE() macro. + + @header{wx/link.h} */ -#define wxFORCE_LINK_MODULE() /* implementation is private */ +#define wxFORCE_LINK_MODULE( moduleName ) + +//@}