build: refactor Doxygen XML build (#110)

* build: remove auto-installation of Doxygen

* build: modify `add_xml_docs` function to `target_generate_xml_docs`

Author: threeal

.github/workflows/build.yaml

@@ -48,8 +48,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4.1.1
 
-      - name: Install Requirements
-        run: pip3 install -r docs/requirements.txt
+      - name: Install Dependencies
+        run: |
+          sudo apt-get install -y doxygen
+          pip3 install -r docs/requirements.txt
 
       - name: Build Documentation
         run: sphinx-build -b html docs build/docs -W --keep-going

.github/workflows/deploy.yaml

@@ -23,8 +23,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4.1.1
 
-      - name: Install Requirements
-        run: pip3 install -r docs/requirements.txt
+      - name: Install Dependencies
+        run: |
+          sudo apt-get install -y doxygen
+          pip3 install -r docs/requirements.txt
 
       - name: Build Documentation
         run: sphinx-build -b html docs docs/build -W --keep-going

CMakeLists.txt

@@ -71,10 +71,9 @@ if(NOT_SUBPROJECT)
     catch_discover_tests(errors_test)
   endif()
 
-  # Build XML documentation
   if(BUILD_DOCS)
-    include(cmake/add_xml_docs.cmake)
-    add_xml_docs(errors_docs include/errors/error.hpp)
+    include(cmake/GenerateDocs.cmake)
+    target_generate_xml_docs(errors)
   endif()
 
   if(BUILD_EXAMPLES)

cmake/GenerateDocs.cmake

@@ -0,0 +1,14 @@
+# Function to generate an XML documentation of a specific target.
+# Arguments:
+#   - TARGET: The target for which to generate an XML documentation.
+function(target_generate_xml_docs TARGET)
+  find_package(Doxygen REQUIRED)
+
+  # Configure Doxygen to generate an XML documentation.
+  set(DOXYGEN_GENERATE_HTML NO)
+  set(DOXYGEN_GENERATE_XML YES)
+  set(DOXYGEN_XML_OUTPUT ${TARGET}_docs)
+
+  get_target_property(TARGET_HEADER_SET ${TARGET} HEADER_SET)
+  doxygen_add_docs(${TARGET}_docs ${TARGET_HEADER_SET} USE_STAMP_FILE)
+endfunction()

cmake/add_xml_docs.cmake

@@ -39,8 +39,7 @@ if(NOT_SUBPROJECT)
     catch_discover_tests(errors_format_test)
   endif()
 
-  # Build XML documentation
   if(BUILD_DOCS)
-    add_xml_docs(errors_format_docs include/errors/format.hpp)
+    target_generate_xml_docs(errors_format)
   endif()
 endif()