From 626eb387b0e08abdeb3379383b2d9fd67ecfd3db Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 15:51:15 +0900 Subject: [PATCH 1/6] Upgrade the Doxygen version to 1.13.0 #339 --- .github/workflows/linux-clang.yml | 2 +- Doxyfile | 73 ++++++++++++++++++++++--------- README.md | 4 +- 3 files changed, 56 insertions(+), 23 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index ddec2118..4e7e52af 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -16,7 +16,7 @@ env: CONCURRENT_BUILD: 4 CLANG_COMMAND: clang-14 CLANGXX_COMMAND: clang++-14 - DOXYGEN_VER: 1.12.0 + DOXYGEN_VER: 1.13.0 DOXYGEN_CACHE_REV: 0 BOOST_VER: 1_87_0 BOOST_VER_DOT: 1.87.0 diff --git a/Doxyfile b/Doxyfile index fe351b24..dc302391 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.12.0 +# Doxyfile 1.13.0 # This file describes the settings to be used by the documentation system # Doxygen (www.doxygen.org) for a project. @@ -51,7 +51,7 @@ PROJECT_NAME = tetengo PROJECT_NUMBER = 1.9.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a +# for a project that appears at the top of each page and should give viewers a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "A multipurpose library set" @@ -80,7 +80,7 @@ OUTPUT_DIRECTORY = # sub-directories (in 2 levels) under the output directory of each output format # and will distribute the generated files over these directories. Enabling this # option can be useful when feeding Doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes +# putting all generated files in the same directory would otherwise cause # performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to # control the number of sub-directories. # The default value is: NO. @@ -192,17 +192,17 @@ STRIP_FROM_PATH = STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, Doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't +# less readable) file names. This can be useful if your file system doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) +# first line (until the first dot, question mark or exclamation mark) of a +# Javadoc-style comment as the brief description. If set to NO, the Javadoc- +# style will behave just like regular Qt-style comments (thus requiring an +# explicit @brief command for a brief description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO @@ -218,9 +218,10 @@ JAVADOC_AUTOBRIEF = NO JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then Doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) +# line (until the first dot, question mark or exclamation mark) of a Qt-style +# comment as the brief description. If set to NO, the Qt-style will behave just +# like regular Qt-style comments (thus requiring an explicit \brief command for +# a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO @@ -373,11 +374,20 @@ MARKDOWN_ID_STYLE = DOXYGEN # When enabled Doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. +# globally by setting AUTOLINK_SUPPORT to NO. Words listed in the +# AUTOLINK_IGNORE_WORDS tag are excluded from automatic linking. # The default value is: YES. AUTOLINK_SUPPORT = YES +# This tag specifies a list of words that, when matching the start of a word in +# the documentation, will suppress auto links generation, if it is enabled via +# AUTOLINK_SUPPORT. This list does not affect affect links explicitly created +# using \# or the \link or commands. +# This tag requires that the tag AUTOLINK_SUPPORT is set to YES. + +AUTOLINK_IGNORE_WORDS = + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let Doxygen match functions declarations and @@ -589,6 +599,14 @@ HIDE_UNDOC_MEMBERS = NO HIDE_UNDOC_CLASSES = NO +# If the HIDE_UNDOC_NAMESPACES tag is set to YES, Doxygen will hide all +# undocumented namespaces that are normally visible in the namespace hierarchy. +# If set to NO, these namespaces will be included in the various overviews. This +# option has no effect if EXTRACT_ALL is enabled. +# The default value is: YES. + +HIDE_UNDOC_NAMESPACES = YES + # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. @@ -980,10 +998,10 @@ INPUT = docsrc \ INPUT_ENCODING = UTF-8 # This tag can be used to specify the character encoding of the source files -# that Doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# that Doxygen parses. The INPUT_FILE_ENCODING tag can be used to specify # character encoding on a per file pattern basis. Doxygen will compare the file # name with each pattern and apply the encoding instead of the default -# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# INPUT_ENCODING if there is a match. The character encodings are a list of the # form: pattern=encoding (like *.php=ISO-8859-1). # See also: INPUT_ENCODING for further information on supported encodings. @@ -1179,6 +1197,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = README.md +# If the IMPLICIT_DIR_DOCS tag is set to YES, any README.md file found in sub- +# directories of the project's root, is used as the documentation for that sub- +# directory, except when the README.md starts with a \dir, \page or \mainpage +# command. If set to NO, the README.md file needs to start with an explicit \dir +# command in order to be used as directory documentation. +# The default value is: YES. + +IMPLICIT_DIR_DOCS = YES + # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common # extension is to allow longer lines before the automatic comment starts. The @@ -1547,9 +1574,9 @@ DOCSET_PUBLISHER_NAME = Publisher # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # on Windows. In the beginning of 2021 Microsoft took the original page, with -# a.o. the download links, offline the HTML help workshop was already many years -# in maintenance mode). You can download the HTML help workshop from the web -# archives at Installation executable (see: +# a.o. the download links, offline (the HTML help workshop was already many +# years in maintenance mode). You can download the HTML help workshop from the +# web archives at Installation executable (see: # http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo # ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # @@ -1708,7 +1735,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO @@ -1725,7 +1752,7 @@ DISABLE_INDEX = NO # shows how to put an image at the root of the tree instead of the PROJECT_NAME. # Since the tree basically has the same information as the tab index, you could # consider setting DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. +# The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES @@ -2137,7 +2164,7 @@ LATEX_HIDE_INDICES = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See # https://en.wikipedia.org/wiki/BibTeX and \cite for more info. -# The default value is: plain. +# The default value is: plainnat. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain @@ -2811,6 +2838,12 @@ PLANTUML_CFG_FILE = PLANTUML_INCLUDE_PATH = +# The PLANTUMLFILE_DIRS tag can be used to specify one or more directories that +# contain PlantUml files that are included in the documentation (see the +# \plantumlfile command). + +PLANTUMLFILE_DIRS = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, Doxygen will truncate the graph, which is visualized diff --git a/README.md b/README.md index d24fc0c0..d0a1c423 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ How to Build and Install - [Visual Studio 2022](https://visualstudio.microsoft.com/) - [Boost C++ libraries 1.87.0](https://www.boost.org/) -- [Doxygen 1.12.0](https://www.doxygen.nl/) +- [Doxygen 1.13.0](https://www.doxygen.nl/) - [Graphviz](https://www.graphviz.org/) - [WiX toolset 5.0.1](https://wixtoolset.org/) - [Python 3.9](https://www.python.org/) or @@ -143,7 +143,7 @@ Doxygen will output the documents into the directory `doc`. [GCC 10](https://gcc.gnu.org/) or [GCC 12](https://gcc.gnu.org/) - [Boost C++ libraries 1.87.0](https://www.boost.org/) -- [Doxygen 1.12.0](https://www.doxygen.nl/) +- [Doxygen 1.13.0](https://www.doxygen.nl/) - [Graphviz](https://www.graphviz.org/) - [include-what-you-use 0.15](https://include-what-you-use.org/) or [include-what-you-use 0.17](https://include-what-you-use.org/) From 93eefc27d7fe9760e5bb851ca17cb4b05628e980 Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 16:18:21 +0900 Subject: [PATCH 2/6] Debug the GitHub Actions script #339 --- .github/workflows/linux-clang.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index 4e7e52af..ce0bddc5 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -290,9 +290,12 @@ jobs: - name: Move artifacts shell: bash run: | - mkdir .artifacts - mv .doxygen/doc .artifacts - mv .build/tetengo-* .artifacts + pwd + ls -lR + mkdir -v .artifacts + mv -v .doxygen/doc .artifacts + mv -v .build/tetengo-* .artifacts + ls -lR - name: Upload artifacts uses: actions/upload-artifact@v4 From 1ce418ea341dbb9a3dc69d20a973a464e879ee1b Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 20:13:14 +0900 Subject: [PATCH 3/6] Debug the GitHub Actions script #339 --- .github/workflows/linux-clang.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index ce0bddc5..b080a3eb 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -291,14 +291,14 @@ jobs: shell: bash run: | pwd - ls -lR - mkdir -v .artifacts - mv -v .doxygen/doc .artifacts - mv -v .build/tetengo-* .artifacts - ls -lR + ls -alR + mkdir -v artifacts + mv -v .doxygen/doc artifacts + mv -v .build/tetengo-* artifacts + ls -alR - name: Upload artifacts uses: actions/upload-artifact@v4 with: name: artifacts-linux - path: .artifacts + path: artifacts From 06e8bc9ca0d88c23b5f98119ba5f91e1b822f9a6 Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 20:23:24 +0900 Subject: [PATCH 4/6] Revert "Debug the GitHub Actions script #339" This reverts commit 1ce418ea341dbb9a3dc69d20a973a464e879ee1b. --- .github/workflows/linux-clang.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index b080a3eb..ce0bddc5 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -291,14 +291,14 @@ jobs: shell: bash run: | pwd - ls -alR - mkdir -v artifacts - mv -v .doxygen/doc artifacts - mv -v .build/tetengo-* artifacts - ls -alR + ls -lR + mkdir -v .artifacts + mv -v .doxygen/doc .artifacts + mv -v .build/tetengo-* .artifacts + ls -lR - name: Upload artifacts uses: actions/upload-artifact@v4 with: name: artifacts-linux - path: artifacts + path: .artifacts From cd1c81b75e5d79171968be8009607e9226fffc18 Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 20:23:28 +0900 Subject: [PATCH 5/6] Revert "Debug the GitHub Actions script #339" This reverts commit 93eefc27d7fe9760e5bb851ca17cb4b05628e980. --- .github/workflows/linux-clang.yml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index ce0bddc5..4e7e52af 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -290,12 +290,9 @@ jobs: - name: Move artifacts shell: bash run: | - pwd - ls -lR - mkdir -v .artifacts - mv -v .doxygen/doc .artifacts - mv -v .build/tetengo-* .artifacts - ls -lR + mkdir .artifacts + mv .doxygen/doc .artifacts + mv .build/tetengo-* .artifacts - name: Upload artifacts uses: actions/upload-artifact@v4 From 1f5cea348126f50ac89ac2ea6fe7e7cafa52ee2c Mon Sep 17 00:00:00 2001 From: kaoru Date: Thu, 2 Jan 2025 20:24:49 +0900 Subject: [PATCH 6/6] Correct the GitHub Actions script #339 --- .github/workflows/linux-clang.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/linux-clang.yml b/.github/workflows/linux-clang.yml index 4e7e52af..2286d162 100644 --- a/.github/workflows/linux-clang.yml +++ b/.github/workflows/linux-clang.yml @@ -290,12 +290,12 @@ jobs: - name: Move artifacts shell: bash run: | - mkdir .artifacts - mv .doxygen/doc .artifacts - mv .build/tetengo-* .artifacts + mkdir artifacts + mv .doxygen/doc artifacts + mv .build/tetengo-* artifacts - name: Upload artifacts uses: actions/upload-artifact@v4 with: name: artifacts-linux - path: .artifacts + path: artifacts