fix doc handling of predefined macros

ginkgo-project · Mar 29, 2022 · fabd596 · fabd596
1 parent 5ef505b
commit fabd596
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -9,6 +9,13 @@ if(GINKGO_DOC_GENERATE_EXAMPLES)
     add_subdirectory(examples)
 endif()
 
+if(GINKGO_BUILD_MPI)
+    set(predefined_build_mpi 1)
+else()
+    set(predefined_build_mpi 0)
+endif()
+set(default_predefined_macros "GKO_HAVE_PAPI_SDE=1 GINKGO_BUILD_MPI=${predefined_build_mpi}")
+
 if (GINKGO_DOC_GENERATE_PDF)
     find_package(LATEX COMPONENTS PDFLATEX REQUIRED)
 endif()

diff --git a/doc/conf/Doxyfile-pdf.in b/doc/conf/Doxyfile-pdf.in
@@ -5,7 +5,7 @@ GENERATE_LATEX         = YES
 LATEX_OUTPUT           = .
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
-COMPACT_LATEX          = NO 
+COMPACT_LATEX          = NO
 PAPER_TYPE             = a4
 EXTRA_PACKAGES         = amsmath amsfonts amssymb mathtools
 LATEX_HEADER           =
@@ -21,7 +21,7 @@ LATEX_BIB_STYLE        = plain
 LATEX_TIMESTAMP        = NO
 
 # this is used to hide protected members
-PREDEFINED = protected=private
+PREDEFINED = @default_predefined_macros@ protected=private
 
 # hide all unnecessary graphs
 CLASS_DIAGRAMS         = NO

diff --git a/doc/conf/Doxyfile-usr.in b/doc/conf/Doxyfile-usr.in
@@ -1,7 +1,7 @@
 GENERATE_HTML          = YES
 
 # this is used to hide protected members
-PREDEFINED = protected=private
+PREDEFINED = @default_predefined_macros@ protected=private
 
 INPUT = @doxygen_markdown_files@ @doxygen_base_input_str@
 EXTRACT_STATIC         = NO

diff --git a/doc/conf/Doxyfile.in b/doc/conf/Doxyfile.in
@@ -28,7 +28,7 @@ FILTER_PATTERNS        = *.cpp=@DIR_SCRIPT@/filter *.hpp=@DIR_SCRIPT@/filter *.c
 FILTER_SOURCE_FILES    = YES
 
 # Parsing options
-PREDEFINED             = GKO_HAVE_PAPI_SDE=1
+PREDEFINED             = @default_predefined_macros@
 JAVADOC_AUTOBRIEF      = Yes
 TAB_SIZE               = 4
 MARKDOWN_SUPPORT       = YES