]> git.saurik.com Git - wxWidgets.git/blob - interface/wx/link.h
Applied minor documentation corrections to wxRegKey from charles (fixes #10407).
[wxWidgets.git] / interface / wx / link.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: link.h
3 // Purpose: interface of global functions
4 // Author: wxWidgets team
5 // RCS-ID: $Id$
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
8
9 /** @addtogroup group_funcmacro_byteorder */
10 //@{
11
12 /**
13 This macro can be used in conjunction with the wxFORCE_LINK_MODULE() macro
14 to force the linker to include in its output a specific object file.
15
16 In particular, you should use this macro in the source file which you want
17 to force for inclusion. The @c moduleName needs to be a name not already in
18 use in other wxFORCE_LINK_THIS_MODULE() macros, but is not required to be
19 e.g. the same name of the source file (even if it's a good choice).
20
21 @header{wx/link.h}
22 */
23 #define wxFORCE_LINK_THIS_MODULE( moduleName )
24
25 /**
26 This macro can be used in conjunction with the wxFORCE_LINK_THIS_MODULE()
27 macro to force the linker to include in its output a specific object file.
28
29 In particular, you should use this macro in a source file which you know
30 for sure is linked in the output (e.g. the source file containing the
31 @c main() of your app). The @c moduleName is the name of the module you
32 want to forcefully link (i.e. the name you used in the relative
33 wxFORCE_LINK_THIS_MODULE() macro.
34
35 @header{wx/link.h}
36 */
37 #define wxFORCE_LINK_MODULE( moduleName )
38
39 //@}
40