Skip to content

Commit d58958e

Browse files
unicornxRbb666
authored andcommitted
doxygen: support 1.9.8
The current test environment is mainly based on Ubuntu 22.04 LTS and doxygen version is 1.9.1. But when we switch to Ubuntu 24.04, the default Doxygen version on Ubuntu 24.04 is 1.9.8. The supported configuration and layout file formats differ from those in 1.9.1 (Ubuntu 22.04). In particular, the layout XML file format of 1.9.8 is incompatible with the older format(1.9.1). Therefore, to support Doxygen on Ubuntu 24.04, we need to load different configuration and layout files. (The layout file is specified using the LAYOUT_FILE parameter in the configuration file.) Solution: Provide corresponding configuration and layout files for different Doxygen versions, distinguished by the Doxygen version number. Currently, only Doxygen versions 1.9.1 and above are supported. If the doxygen version is >= 1.9.1 but < 1.9.8, the 1.9.1 configuration and layout are used by default. If the doxygen version is >= 1.9.8, the 1.9.8 configuration and layout are used. Only 1.9.1 and 1.9.8 have been tested, as these are the default doxygen versions on Ubuntu 22.04 LTS and Ubuntu 24.04. Other versions have not been tested yet. If necessary, we will change the configuration based on the same approach in the future. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
1 parent cc72712 commit d58958e

File tree

6 files changed

+3184
-5
lines changed

6 files changed

+3184
-5
lines changed

.github/workflows/doxygen.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ jobs:
5959
shell: bash
6060
run: |
6161
cd documentation
62-
doxygen Doxyfile
63-
cat Doxyfile
62+
doxygen Doxyfile.1.9.1
63+
cat Doxyfile.1.9.1
6464
6565
- name: Upload static files as artifact
6666
id: deployment

documentation/Doxyfile renamed to documentation/Doxyfile.1.9.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -773,7 +773,7 @@ FILE_VERSION_FILTER =
773773
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
774774
# tag is left empty.
775775

776-
LAYOUT_FILE = DoxygenLayout.xml
776+
LAYOUT_FILE = DoxygenLayout-1.9.1.xml
777777

778778
# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
779779
# the reference definitions. This must be a list of .bib files. The .bib

0 commit comments

Comments
 (0)