diff options
| author | Ray Molenkamp <github@lazydodo.com> | 2021-06-10 03:44:39 +0300 |
|---|---|---|
| committer | Ray Molenkamp <github@lazydodo.com> | 2021-06-10 03:44:39 +0300 |
| commit | b282a065f161812a0797e954edc419784a69630e (patch) | |
| tree | 62e85e33bfef26fbfd93cfe607dd71d46eaed75d /doc | |
| parent | 4f81b4b4ce2993d583a093f7e278c1274c1ca1cb (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/Doxyfile | 3 |
1 files changed, 2 insertions, 1 deletions
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 |