]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/mainpages/const_cpp.h
Revert "Make wxMSW stack walking methods work with Unicode identifiers."
[wxWidgets.git] / docs / doxygen / mainpages / const_cpp.h
index 69257230ab90856420d8e2002c2984c3a04f8bc9..af2b12d4338f1c49d1e5582b295face51336ce1f 100644 (file)
@@ -2,31 +2,22 @@
 // Name:        const_cpp.h
 // Purpose:     Preprocessor symbols
 // Author:      Vadim Zeitlin
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
 
-@page page_cppconst Preprocessor symbols defined by wxWidgets
+@page page_cppconst Preprocessor Symbols
 
-These are preprocessor symbols used in the wxWidgets source, grouped
-by category (and sorted by alphabetical order inside each category).
-All of these macros except for the @c wxUSE_XXX variety is defined if the
-corresponding condition is @true and undefined if it isn't, so they should be
-always tested using @ifdef_ and not @if_.
+@tableofcontents
 
-@li @ref page_cppconst_guisystem
-@li @ref page_cppconst_os
-@li @ref page_cppconst_cpu
-@li @ref page_cppconst_hardware
-@li @ref page_cppconst_compiler
-@li @ref page_cppconst_featuretests
-@li @ref page_cppconst_msvc_setup_h
-@li @ref page_cppconst_miscellaneous
+These are preprocessor symbols used in the wxWidgets source, grouped by
+category (and sorted by alphabetical order inside each category). All of these
+macros except for the @c wxUSE_XXX variety is defined if the corresponding
+condition is @true and undefined if it isn't, so they should be always tested
+using @ifdef_ and not @if_.
 
-<hr>
 
 
 @section page_cppconst_guisystem GUI system
@@ -81,7 +72,8 @@ The convention is to use the @c __WX prefix for these
 symbols, although this has not always been followed.
 
 
-@section page_cppconst_os Operating systems
+
+@section page_cppconst_os Operating Systems
 
 @beginDefList
 @itemdef{__APPLE__, any Mac OS version}
@@ -117,7 +109,7 @@ symbols, although this has not always been followed.
 
 
 
-@section page_cppconst_cpu Hardware architectures (CPU)
+@section page_cppconst_cpu Hardware Architectures (CPU)
 
 Note that not all of these symbols are always defined, it depends on the
 compiler used.
@@ -131,7 +123,7 @@ compiler used.
 
 
 
-@section page_cppconst_hardware Hardware type
+@section page_cppconst_hardware Hardware Type
 
 @beginDefList
 @itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display}
@@ -164,7 +156,7 @@ compiler used.
                     @c 1020 for @c 4.2 (the first supported version), @c 1100 for
                     @c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
                     __VISUALCn__ are also defined for each major compiler version from
-                    5 to 11, i.e. you can use tests such @ifdef_ __VISUALC7__ to test
+                    5 to 12, i.e. you can use tests such @ifdef_ __VISUALC7__ to test
                     for compiler version being precisely 7.}
 @itemdef{__XLC__, AIX compiler}
 @itemdef{__WATCOMC__, Watcom C++. The value of this macro corresponds to
@@ -173,7 +165,7 @@ compiler used.
 
 
 
-@section page_cppconst_featuretests Feature tests
+@section page_cppconst_featuretests Feature Tests
 
 Some library features may not be always available even if they were selected
 by the user. To make it possible to check if this is the case, the library
@@ -224,7 +216,7 @@ Currently the following symbols exist:
 
 
 
-@section page_cppconst_msvc_setup_h Libraries selection for MSVC setup.h
+@section page_cppconst_msvc_setup_h Library Selection for MSVC
 
 Microsoft Visual C++ users may use the special @c wx/setup.h file for this
 compiler in @c include/msvc subdirectory. This file implicitly links in all the
@@ -234,6 +226,7 @@ configurations. However sometimes linking with all the libraries is not
 desirable, for example because some of them were not built and this is where
 the symbols in this section can be helpful: defining them allows to not link
 with the corresponding library. The following symbols are honoured:
+
     - wxNO_ADV_LIB
     - wxNO_AUI_LIB
     - wxNO_HTML_LIB
@@ -254,6 +247,12 @@ with the corresponding library. The following symbols are honoured:
 Notice that the base library is always included and the core is always included
 for the GUI applications (i.e. those which don't define @c wxUSE_GUI as 0).
 
+If the makefiles have been used to build the libraries from source and the @c CFG
+variable has been set to specify a different output path for that particular
+configuration of build then the @c wxCFG preprocessor symbol should be set in
+the project that uses wxWidgets to the same value as the @c CFG variable in
+order for the correct @c wx/setup.h file to automatically be included for that
+configuration.
 
 @section page_cppconst_miscellaneous Miscellaneous