Merge pull request #198 from eseiler/infra/doxygen

[INFRA] Update doxygen

.github/workflows/ci_documentation.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Install Doxygen
         uses: seqan/actions/setup-doxygen@main
         with:
-          doxygen: 1.9.8
+          doxygen: 1.10.0
 
       - name: Configure tests
         run: |

cmake/package-lock.cmake

@@ -36,3 +36,10 @@ CPMDeclarePackage (googletest
                    GITHUB_REPOSITORY google/googletest
                    SYSTEM TRUE
                    OPTIONS "BUILD_GMOCK OFF" "INSTALL_GTEST OFF")
+# doxygen-awesome
+set (HIBF_DOXYGEN_AWESOME_VERSION 2.3.2)
+CPMDeclarePackage (doxygen_awesome
+                   NAME doxygen_awesome
+                   VERSION ${HIBF_DOXYGEN_AWESOME_VERSION}
+                   GITHUB_REPOSITORY jothepro/doxygen-awesome-css
+                   DOWNLOAD_ONLY TRUE)

include/hibf/platform.hpp

@@ -31,7 +31,7 @@
 
 /*!\def HIBF_COMPILER_IS_GCC
  * \brief Whether the current compiler is GCC.
- * \ingroup core
+ * \private
  * \details
  * __GNUC__ is also used to indicate the support for GNU compiler extensions. To detect the presence of the GCC
  * compiler, one has to rule out other compilers.
@@ -51,7 +51,7 @@
 
 /*!\def HIBF_HAS_AVX512
  * \brief Whether AVX512F and AVX512BW are available.
- * \ingroup core
+ * \private
  */
 #ifndef HIBF_HAS_AVX512
 #    if __AVX512F__ && __AVX512BW__

test/documentation/.vercel/0_setup.sh

@@ -6,7 +6,7 @@
 
 set -euxo pipefail
 
-DOXYGEN_VERSION=1.9.8
+DOXYGEN_VERSION=1.10.0
 WORK_DIR=`pwd`
 CACHE_DIR="${WORK_DIR}/node_modules" # The node_modules directory is always cached.
 

test/documentation/CMakeLists.txt

@@ -24,6 +24,13 @@ else ()
     message (FATAL_ERROR "Could not find HIBF. Not building documentation.")
 endif ()
 
+set (CPM_INDENT "CMake Package Manager CPM: ")
+include (${HIBF_SOURCE_DIR}/../../cmake/CPM.cmake)
+CPMUsePackageLock (${HIBF_SOURCE_DIR}/../../cmake/package-lock.cmake)
+
+# Sets doxygen_awesome_SOURCE_DIR
+CPMGetPackage (doxygen_awesome)
+
 set (HIBF_DOXYGEN_INPUT_DIR "${CMAKE_SOURCE_DIR}")
 
 include (hibf-doxygen.cmake)

test/documentation/DoxygenLayout.xml

@@ -7,11 +7,9 @@ SPDX-License-Identifier: BSD-3-Clause
 -->
 
 <doxygenlayout version="1.0">
-  <!-- Generated by doxygen 1.9.8 -->
+  <!-- Generated by doxygen 1.10.0 -->
   <!-- Navigation index tabs for HTML output -->
   <navindex>
-    <tab type="mainpage" visible="no" title=""/>
-    <tab type="pages" visible="no" title="" intro=""/>
     <!-- Setup pages are added in hibf-doxygen-layout.cmake automatically for each doc/setup/*/index.md file -->
     <!-- <tab type="usergroup" visible="yes" title="Setup" intro=""> -->
     <!-- </tab> -->
@@ -31,10 +29,10 @@ SPDX-License-Identifier: BSD-3-Clause
     </tab>
     <tab type="topics" visible="yes" title="API Reference" intro=""/>
     <tab type="usergroup" visible="yes" title="API Reference (details)" intro="">
-    <tab type="modules" visible="no" title="" intro="">
-      <tab type="modulelist" visible="yes" title="" intro=""/>
-      <tab type="modulemembers" visible="yes" title="" intro=""/>
-    </tab>
+      <tab type="modules" visible="no" title="" intro="">
+        <tab type="modulelist" visible="yes" title="" intro=""/>
+        <tab type="modulemembers" visible="yes" title="" intro=""/>
+      </tab>
       <tab type="namespaces" visible="no" title="">
         <tab type="namespacelist" visible="yes" title="" intro=""/>
         <tab type="namespacemembers" visible="yes" title="" intro=""/>
@@ -145,6 +143,7 @@ SPDX-License-Identifier: BSD-3-Clause
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <detaileddescription title=""/>
@@ -156,6 +155,7 @@ SPDX-License-Identifier: BSD-3-Clause
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection visible="yes"/>
   </namespace>
@@ -191,6 +191,7 @@ SPDX-License-Identifier: BSD-3-Clause
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
       <membergroups visible="yes"/>
     </memberdecl>
     <detaileddescription title=""/>
@@ -203,6 +204,7 @@ SPDX-License-Identifier: BSD-3-Clause
       <enums title=""/>
       <functions title=""/>
       <variables title=""/>
+      <properties title=""/>
     </memberdef>
     <authorsection/>
   </file>