[INFRA] Update doxygen

seqan · Feb 7, 2024 · cc74c94 · cc74c94
1 parent fc521fe
commit cc74c94
Show file tree

Hide file tree

Showing 12 changed files with 305 additions and 83 deletions.
diff --git a/.github/workflows/ci_documentation.yml b/.github/workflows/ci_documentation.yml
@@ -50,7 +50,7 @@ jobs:
       - name: Install Doxygen
         uses: seqan/actions/setup-doxygen@main
         with:
-          doxygen: 1.9.6
+          doxygen: 1.10.0
 
       - name: Configure tests
         run: |

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -52,7 +52,7 @@ jobs:
       - name: Install Doxygen
         uses: seqan/actions/setup-doxygen@main
         with:
-          doxygen: 1.9.6
+          doxygen: 1.10.0
 
       - name: Load cached documentation
         uses: actions/cache@v4

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -31,6 +31,8 @@ If possible, provide tooling that performs the changes, e.g. a shell-script.
 #### Dependencies
   * TDL is now an optional dependency and can be force deactivated via CMake (`-DSHARG_NO_TDL=ON`)
     ([#218](https://github.com/seqan/sharg-parser/pull/218)).
+  * We now use Doxygen version 1.10.0 to build our documentation
+    ([\#230](https://github.com/seqan/sharg-parser/pull/230)).
 
 # Release 1.1.1
 

diff --git a/include/sharg/enumeration_names.hpp b/include/sharg/enumeration_names.hpp
@@ -209,11 +209,9 @@ namespace sharg
  * \experimentalapi{Experimental since version 1.0.}
  */
 // clang-format off
-// `SHARG_DOXYGEN_ONLY((size_t value))` is needed for Doxygen 1.9.5
-// Doxygen 1.9.5 bug: https://github.com/doxygen/doxygen/issues/9552
 template <typename option_type>
     requires requires { { detail::adl_only::enumeration_names_cpo<option_type>{}() }; }
-inline auto const enumeration_names SHARG_DOXYGEN_ONLY((size_t value)) = detail::adl_only::enumeration_names_cpo<option_type>{}();
+inline auto const enumeration_names = detail::adl_only::enumeration_names_cpo<option_type>{}();
 // clang-format on
 //!\}
 

diff --git a/test/documentation/.vercel/install.sh b/test/documentation/.vercel/install.sh
@@ -6,7 +6,7 @@
 
 set -exo pipefail
 
-DOXYGEN_VERSION=1.9.6
+DOXYGEN_VERSION=1.10.0
 SOURCE_DIR=`pwd`
 CACHE_DIR="${SOURCE_DIR}/node_modules"
 

diff --git a/test/documentation/DoxygenLayout.xml.in b/test/documentation/DoxygenLayout.xml.in
@@ -4,15 +4,15 @@
 -->
 
 <doxygenlayout version="1.0">
-  <!-- Generated by doxygen 1.9.6 -->
+  <!-- Generated by doxygen 1.10.0 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
     <tab type="mainpage" visible="yes" title=""/>
     <tab type="pages" visible="no" title="" intro=""/>
     <!-- Custom vvv -->
     <tab type="usergroup" visible="yes" title="Setup" intro="">
       <tab type="user" visible="yes" title="Quick-Setup (CMake)" url="\ref setup" intro=""/>
-      <tab type="user" visible="yes" title="Library tests" url="\ref setup_tests" intro=""/>
+      <tab type="user" visible="${SHARG_SHOW_DEV_GROUP}" title="Library tests" url="\ref setup_tests" intro=""/>
     </tab>
     <tab type="usergroup" visible="yes" title="Tutorial" intro="">
       <tab type="user" visible="yes" title="Parsing command line arguments" url="@ref tutorial_parser" intro=""/>
@@ -33,11 +33,13 @@
       <tab type="user" visible="yes" title="Update Notifications" url="\ref about_update_notifications" intro=""/>
     </tab>
     <!-- Custom ^^^ -->
-    <tab type="modules" visible="yes" title="API Reference" intro=""/>
-    <tab type="usergroup" visible="${SHARG_SHOW_DEV_GROUP}" title="API Reference (details)" intro=""> <!-- Custom -->
+    <tab type="topics" visible="yes" title="API Reference" intro=""/>
+    <tab type="usergroup" visible="yes" title="API Reference (details)" intro=""> <!-- Custom -->
       <tab type="namespaces" visible="no" title="">
         <tab type="namespacelist" visible="yes" title="" intro=""/>
-        <tab type="namespacemembers" visible="yes" title="" intro=""/>
+        <tab type="namespacemembers" visible="${SHARG_SHOW_DEV_GROUP}" title="" intro=""/>
+      </tab>
+      <tab type="concepts" visible="yes" title="">
       </tab>
       <tab type="interfaces" visible="no" title="">
         <tab type="interfacelist" visible="yes" title="" intro=""/>
@@ -50,8 +52,6 @@
         <tab type="hierarchy" visible="yes" title="" intro=""/>
         <tab type="classmembers" visible="yes" title="" intro=""/>
       </tab>
-      <tab type="concepts" visible="yes" title="">
-      </tab>
       <tab type="structs" visible="no" title="">
         <tab type="structlist" visible="yes" title="" intro=""/>
         <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
@@ -145,6 +145,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <detaileddescription title=""/>
@@ -156,6 +157,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection visible="yes"/>
   </namespace>
@@ -191,6 +193,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <detaileddescription title=""/>
@@ -203,6 +206,7 @@
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection/>
   </file>
@@ -213,6 +217,7 @@
     <groupgraph visible="$GROUP_GRAPHS"/>
     <memberdecl>
       <nestedgroups visible="yes" title=""/>
+      <modules visible="yes" title=""/>
       <dirs visible="yes" title=""/>
       <files visible="yes" title=""/>
       <namespaces visible="yes" title=""/>
@@ -258,6 +263,25 @@
     <authorsection visible="yes"/>
   </group>
 
+  <!-- Layout definition for a C++20 module page -->
+  <module>
+    <briefdescription visible="yes"/>
+    <exportedmodules visible="yes"/>
+    <memberdecl>
+      <concepts visible="yes" title=""/>
+      <classes visible="yes" title=""/>
+      <enums title=""/>
+      <typedefs title=""/>
+      <functions title=""/>
+      <variables title=""/>
+      <membergroups title=""/>
+    </memberdecl>
+    <detaileddescription title=""/>
+    <memberdecl>
+      <files visible="yes"/>
+    </memberdecl>
+  </module>
+
   <!-- Layout definition for a directory page -->
   <directory>
     <briefdescription visible="yes"/>

diff --git a/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js b/test/documentation/doxygen-awesome/doxygen-awesome-tabs.js
@@ -42,6 +42,7 @@ class DoxygenAwesomeTabs {
                     let tabLink = document.createElement("button")
                     tabLink.classList.add("tab-button")
                     tabLink.appendChild(header)
+                    header.title = header.textContent
                     tabLink.addEventListener("click", () => {
                         tabbed.querySelectorAll("li").forEach((tab) => {
                             tab.classList.remove("selected")
@@ -67,7 +68,26 @@ class DoxygenAwesomeTabs {
                 })
                 tabsOverviewContainer.appendChild(tabsOverview)
                 tabbed.before(tabsOverviewContainer)
+
+                function resize() {
+                    let maxTabHeight = 0
+                    tabbed.querySelectorAll("li").forEach((tab, tabIndex) => {
+                        let visibility = tab.style.display
+                        tab.style.display = "block"
+                        maxTabHeight = Math.max(tab.offsetHeight, maxTabHeight)
+                        tab.style.display = visibility
+                    })
+                    tabbed.style.height = `${maxTabHeight + 10}px`
+                }
+
+                resize()
+                new ResizeObserver(resize).observe(tabbed)
             })
         })
+
+    }
+
+    static resize(tabbed) {
+
     }
 }