[Bf-blender-cvs] [b282a065f16] master: Docs: Add preprocessor define for doxygen

[Ray Molenkamp]

Commit: b282a065f161812a0797e954edc419784a69630e
Author: Ray Molenkamp
Date:   Wed Jun 9 18:44:39 2021 -0600
Branches: master
https://developer.blender.org/rBb282a065f161812a0797e954edc419784a69630e

Docs: Add preprocessor define for doxygen

Doxygen by default leaves out any functions inside
#ifdef blocks that it thinks are disabled.

This change adds a DOXYGEN symbol, so you can
still get the functions included in the
documentation even if the #ifdef would
have normally excluded them.

before

#if defined(_WIN32)

after

#if defined(_WIN32) || defined(DOXYGEN)

Patch provided by Campbell Barton on chat.

===================================================================

M	doc/doxygen/Doxyfile

===================================================================

diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile
index 201d2208486..97bd85aae11 100644
--- a/doc/doxygen/Doxyfile
+++ b/doc/doxygen/Doxyfile
@@ -2126,7 +2126,8 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = BUILD_DATE
+PREDEFINED             = BUILD_DATE \
+                         "DOXYGEN=1"
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The