From 458d261ad2cc9f5934606520778ef6e387e94ce2 Mon Sep 17 00:00:00 2001
From: "Joachim Wuttke (o)" <j.wuttke@fz-juelich.de>
Date: Tue, 9 Nov 2021 15:49:11 +0100
Subject: [PATCH] explanatory note about macros SWIG and USER_API

---
 CMakeLists.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index db819858e24..cc41caa6b81 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -79,6 +79,10 @@ option(BORNAGAIN_DEBUG_OPTIMIZATION "Build with debug optimization (gcc only)" O
 option(BORNAGAIN_TIDY "Invokes clang-tidy" OFF)
 option(ALGORITHM_DIAGNOSTIC "Let some algorithms set diagnostic variables" OFF)
 
+# note on two non-options:
+# macro SWIG is defined when code is processed by the tool Swig.
+# macros SWIG and USER_API are set by Doc/Doxygen/user/Doxyfile.in
+
 if(BORNAGAIN_TIDY AND BORNAGAIN_PYTHON)
     message(FATAL_ERROR "BORNAGAIN_TIDY is incompatible with BORNAGAIN_PYTHON")
 endif()
-- 
GitLab