Skip to content

doxygen: support 1.9.8 #10777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Rbb666 merged 1 commit into from
Oct 10, 2025
Merged

doxygen: support 1.9.8 #10777

Rbb666 merged 1 commit into from
Oct 10, 2025

Conversation

@unicornx
Copy link
Contributor

@unicornx unicornx commented Oct 10, 2025

目前测试环境主要基于 Ubuntu 22.04LTS（doxygen 版本是 1.9.1）。但 Ubuntu 24.04 上默认的 doxygen 版本是 1.9.8，其支持的 configgure 文件和 layout文件格式和 1.9.1（ubuntu 22.04）不同，特别是 1.9.8 的 layout XML 文件的格式并不兼容旧的 1.9.1 的格式，所以如果要支持在 Ubuntu 24.04 上运行 doxygen，需要加载不同的 config 文件和 layout 文件。（layout 文件通过在 config 文件中的 LAYOUT_FILE 参数指定。）

解决方案：针对不同版本的 doxygen 提供对应的 config & layout 文件，通过 doxygen 的版本号区分。
目前只支持 1.9.1 以上的 doxygen。
如果 doxygen 的版本号 >= 1.9.1 但 < 1.9.8, 默认使用 1.9.1 的 config & layout；如果 doxygen 的版本号 >= 1.9.8 则使用 1.9.8 的 config & layout。

只测试了 1.9.1 和 1.9.8，因为这是 ubuntu 22.04 LTS 和 ubuntu 24.04 上 doxygen 的默认版本，其他版本暂未测试，如果需要以后再基于相同思路更改。

@github-actions github-actions bot added the Doc This PR/issue related with documents label Oct 10, 2025
@github-actions
Copy link

github-actions bot commented Oct 10, 2025

👋 感谢您对 RT-Thread 的贡献！Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范，请在你的仓库中执行以下步骤运行代码格式化工作流（如果格式化CI运行失败）。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).

🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录（目录请以"/"结尾）
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to：dev-doxygen-198
  • 设置PR number为 \ Set the PR number to：10777
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后，提交将自动更新至 dev-doxygen-198 分支，关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the dev-doxygen-198 branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们，再次感谢您的贡献！💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions
Copy link

github-actions bot commented Oct 10, 2025 •
edited
Loading

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: CXSforHPU GorrayLi lianux-mm unicornx

Changed Files (Click to expand)
  • documentation/Doxyfile.1.9.1
  • documentation/Doxyfile.1.9.8
  • documentation/DoxygenLayout-1.9.1.xml
  • documentation/DoxygenLayout-1.9.8.xml
  • documentation/run.sh

🏷️ Tag: workflow

Reviewers: Rbb666 kurisaW supperthomas

Changed Files (Click to expand)
  • .github/workflows/doxygen.yml

📊 Current Review Status (Last Updated: 2025-10-10 11:42 CST)

  • ⌛ CXSforHPU Pending Review
  • ⌛ GorrayLi Pending Review
  • ⌛ Rbb666 Pending Review
  • ⌛ kurisaW Pending Review
  • ⌛ lianux-mm Pending Review
  • ⌛ supperthomas Pending Review
  • ⌛ unicornx Pending Review

📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@unicornx unicornx requested review from Rbb666 and removed request for Cathy-lulu and mysterywolf October 10, 2025 03:17
@github-actions github-actions bot added the action github action yml imporve label Oct 10, 2025
@unicornx
doxygen: support 1.9.8
8a86b28 
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>
@Rbb666 Rbb666 merged commit d58958e into RT-Thread:master Oct 10, 2025
28 checks passed
@Rbb666 Rbb666 mentioned this pull request Oct 10, 2025
Closed
10 tasks
@unicornx unicornx deleted the dev-doxygen-198 branch October 11, 2025 02:23
@supperthomas
Copy link
Member

supperthomas commented Oct 11, 2025

rt-thread/.github/workflows/doxygen.yml

Line 46 in 5ae232b

runs-on: ubuntu-22.04

这个ubuntu版本可以修改为24.08 如果需要1.9.8的话。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Rbb666 Rbb666 Rbb666 approved these changes

@supperthomas supperthomas Awaiting requested review from supperthomas supperthomas is a code owner

@kurisaW kurisaW Awaiting requested review from kurisaW kurisaW is a code owner

Assignees

No one assigned

Labels

action github action yml imporve Doc This PR/issue related with documents

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@unicornx @supperthomas @Rbb666