X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..bfb6fde371c9b5296c3b1c2764a1062db383c6ad:/interface/link.h diff --git a/interface/link.h b/interface/link.h index 5cf6774bc9..8bd169380e 100644 --- a/interface/link.h +++ b/interface/link.h @@ -1,32 +1,40 @@ ///////////////////////////////////////////////////////////////////////////// // Name: link.h -// Purpose: documentation for global functions +// 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). -*/ -#define wxFORCE_LINK_THIS_MODULE() /* implementation is private */ + 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 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( 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. -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. + 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 + @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 ) + +//@}