Intial review of calctrl.h.

[wxWidgets.git] / interface / link.h

diff --git a/interface/link.h b/interface/link.h
index 0714f6c6d2b247f333bc16eb05bc3b9ec80853e4..8bd169380e65e0d5d2459e53979b0ae75680a170 100644 (file)
--- 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 )
+
+//@}