From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Fri, 27 May 2005 16:20:10 +0000 (+0000)
Subject: documented WX_PRECOMP
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/d5df691802112b67f72b2d02d48f2434c99de196?ds=inline

documented WX_PRECOMP


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@34374 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex
index d6c9c3698c..9891f0a1c7 100644
--- a/docs/latex/wx/cppconst.tex
+++ b/docs/latex/wx/cppconst.tex
@@ -153,6 +153,13 @@ also \helpref{wxCHECK\_VERSION}{wxcheckversion}}
 \twocolitem{wxUSE\_XXX}{if defined as $1$, feature XXX is active
 (the symbols of this form are always defined, use \#if and not \#ifdef to test
  for them)}
+\twocolitem{WX\_PRECOMP}{is defined if precompiled headers (PCH) are in use. In
+this case, \texttt{wx/wxprec.h} includes \texttt{wx/wx.h} which, in turn,
+includes a number of wxWidgets headers thus making it unnecessary to include
+them explicitly. However if this is not defined, you do need to include them
+and so the usual idiom which allows to support both cases is to first include 
+\texttt{wx/wxprec.h} and then, inside \texttt{#ifndef WX\_PRECOMP}, individual
+headers you need.}
 \twocolitem{\_UNICODE and UNICODE}{both are defined if wxUSE\_UNICODE is set to $1$}
 \twocolitem{wxUSE\_GUI}{this particular feature test macro is defined to $1$
 when compiling or using the library with the GUI features activated, if it is