Author: manolo Date: 2011-03-02 12:31:24 -0800 (Wed, 02 Mar 2011) New Revision: 596 Log: Updated definition of FL_DOXYGEN preprocessor variable.
Modified: trunk/cmp.php Modified: trunk/cmp.php =================================================================== --- trunk/cmp.php 2011-03-02 16:12:09 UTC (rev 595) +++ trunk/cmp.php 2011-03-02 20:31:24 UTC (rev 596) @@ -1189,12 +1189,18 @@ highly subject to changes, though. <li>FL_DOXYGEN is defined when the Doxygen program that builds -the FLTK documentation processes the source code. The FL_DOXYGEN variable has two major uses. +the FLTK documentation processes the source code. This variable +has two major uses. <ol> <li> #ifndef FL_DOXYGEN / #endif allows to hide code from Doxygen. -<li> #if defined(__APPLE__) || defined(FL_DOXYGEN) / #endif allows -some platform-specific code (__APPLE__) to be seen by Doxygen, -even if Doxygen is run on another system (e.g. Linux). +<li>The Doxygen program does not define the platform-diagnostic +variables __APPLE__ or WIN32 (even if it's run on Mac OS or MSWindows). +Thus, for some platform-specific (say, Mac-specific) code to be +seen by Doxygen, one must bracket it as follows: +<pre><tt>#if defined(__APPLE__) || defined(FL_DOXYGEN) +... Mac-specific code ... +#endif +</tt></pre> </ol> </ul> _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
