From 6af9ccb139191cee9b2a894985418651ccfb5ec5 Mon Sep 17 00:00:00 2001
From: Abe Tomoaki <abe@clear-code.com>
Date: Tue, 30 Jul 2024 14:44:42 +0900
Subject: [PATCH] ci: Run doxygen to check for correct markup (#1830)

Updated settings for running doxygen with CI.

* QUIET = YES
  * The warning log is hard to find, so the generation log is not output
* WARN_AS_ERROR = FAIL_ON_WARNINGS
  * If there is a warning, it should be terminated abnormally
---
 .github/workflows/document.yml | 38 ++++++++++++++++++++++++++++++++++
 doc/Doxyfile                   |  4 ++--
 2 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/document.yml

diff --git a/.github/workflows/document.yml b/.github/workflows/document.yml
new file mode 100644
index 0000000000..9da84e9907
--- /dev/null
+++ b/.github/workflows/document.yml
@@ -0,0 +1,38 @@
+name: Build document
+on:
+  push:
+    branches:
+      - main
+      - 'maintenance/**'
+    tags:
+      - '*'
+    paths:
+      - 'Rakefile'
+      - 'doc/Doxyfile'
+      - 'include/**/*.h'
+      - 'include/**/*.hpp'
+      - '.github/workflows/document.yml'
+  pull_request:
+    paths:
+      - 'Rakefile'
+      - 'doc/Doxyfile'
+      - 'include/**/*.h'
+      - 'include/**/*.hpp'
+      - '.github/workflows/document.yml'
+concurrency:
+  group: ${{ github.head_ref || github.sha }}-${{ github.workflow }}
+  cancel-in-progress: true
+jobs:
+  # todo: Build and publish the full document, including Sphinx.
+  doxygen:
+    name: Doxygen
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+      - name: Install Doxygen
+        run: sudo apt install -y -V doxygen graphviz
+      - name: Run Doxygen
+        run: rake document:api
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 8bff99ec16..998d3c982d 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -810,7 +810,7 @@ CITE_BIB_FILES         =
 # messages are off.
 # The default value is: NO.
 
-QUIET                  = NO
+QUIET                  = YES
 
 # The WARNINGS tag can be used to turn on/off the warning messages that are
 # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
@@ -852,7 +852,7 @@ WARN_NO_PARAMDOC       = NO
 # Possible values are: NO, YES and FAIL_ON_WARNINGS.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = FAIL_ON_WARNINGS
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which