]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Doxygen: set up DoxygenLayout.xml "topics" or "modules" depending on doxygen version 17279/head
authorMatthias Maier <tamiko@43-1.org>
Sun, 21 Jul 2024 10:30:36 +0000 (05:30 -0500)
committerMatthias Maier <tamiko@43-1.org>
Sun, 21 Jul 2024 10:43:37 +0000 (05:43 -0500)
doc/doxygen/CMakeLists.txt
doc/doxygen/DoxygenLayout.xml.in [moved from doc/doxygen/DoxygenLayout.xml with 99% similarity]
doc/doxygen/options.dox.in

index ac62075a006e31604c47c545c1e67a6e8aaa6df8..eca6f2002d4a7aec423fed10ce128579a1ca5e1a 100644 (file)
@@ -114,6 +114,23 @@ configure_file(
   ${CMAKE_CURRENT_BINARY_DIR}/options.dox
   )
 
+#
+# Set up DoxygenLayout.xml. Note that the "Modules" tab has been renamed to
+# "Topics" in Doxygen 1.9.8 to avoid confusion with C++ modules.
+# Unfortunately, this requires us to play a little bit of a configuration
+# dance:
+#
+if(${DOXYGEN_VERSION} VERSION_LESS 1.9.8)
+  set(_topics_layout_flag "<tab type=\"modules\" visible=\"yes\" title=\"\" intro=\"\"/>")
+else()
+  set(_topics_layout_flag "<tab type=\"topics\" visible=\"yes\" title=\"\" intro=\"\"/>")
+endif()
+
+configure_file(
+  ${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml.in
+  ${CMAKE_CURRENT_BINARY_DIR}/DoxygenLayout.xml
+  )
+
 # Figure out the last copyright date of any of the deal.II source
 # files. We will use this then to set the copyright date of the
 # doxygen-generated HTML files.
@@ -319,7 +336,7 @@ add_custom_command(
     ${CMAKE_CURRENT_BINARY_DIR}/options.dox
     ${CMAKE_CURRENT_BINARY_DIR}/header.html
     ${CMAKE_CURRENT_BINARY_DIR}/footer.html
-    ${CMAKE_CURRENT_SOURCE_DIR}/DoxygenLayout.xml
+    ${CMAKE_CURRENT_BINARY_DIR}/DoxygenLayout.xml
     ${CMAKE_CURRENT_SOURCE_DIR}/scripts/filter.pl
     ${_doxygen_depend}
     expand_all_instantiations
similarity index 99%
rename from doc/doxygen/DoxygenLayout.xml
rename to doc/doxygen/DoxygenLayout.xml.in
index 715472d84d4c32e00ae64d0b162423d0698dabc3..4115a79ee9a755ee772efa4fa4c75a363ce578c0 100644 (file)
@@ -5,7 +5,7 @@
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="user" visible="yes" title="Tutorial" url="@ref Tutorial" />
     <tab type="user" visible="yes" title="Code gallery" url="@ref CodeGallery" />
-    <tab type="modules" visible="yes" title="" intro=""/>
+    @_topics_layout_flag@
     <tab type="namespaces" visible="yes" title="">
       <tab type="namespacelist" visible="yes" title="" intro=""/>
       <tab type="namespacemembers" visible="yes" title="" intro=""/>
index 5c18ab87057d459414f487d66cfca8d09481a62b..1915c27201fe6bd4d89ae03ec14f8cb3c0a7f343 100644 (file)
@@ -126,7 +126,7 @@ MATHJAX_EXTENSIONS     = TeX/AMSmath TeX/AMSsymbols
 HTML_COLORSTYLE_HUE    = 220
 HTML_COLORSTYLE_SAT    = 200
 HTML_EXTRA_STYLESHEET  = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
-LAYOUT_FILE            = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml
+LAYOUT_FILE            = @CMAKE_CURRENT_BINARY_DIR@/DoxygenLayout.xml
 
 
 #---------------------------------------------------------------------------

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.