Skip to content

doxygen: group examples in subpages #10082

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.

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

Merged
merged 1 commit into from
Mar 6, 2025

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Mar 6, 2025

将 doxygen 的例子分组后显示在不同的 page 上,这样可以在文档中方便地链接到相关类型的 page。譬如 macro 的例子有自己单独的 page,function 的例子有自己单独的 page,这样就和各自的代码例子,譬如 macro.h 或者 function.h 对应起来了。

Module 部分页面未分组前的效果:
image

Module 部分页面分组后的效果:
image

分组后可以通过页面链接快速跳转到对应的例子的 html 渲染效果:

image

macro 的 doxygen 注释渲染后的效果,现在集中在一个独立的页面上,方便在线随时查看。
image

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

见前面 PR 描述。

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

Doxygen examples are grouped on different pages so that you can
easily link to pages of related types in the documentation.
For example, macro examples have their own page, and function
examples have their own page, which correspond to their own code
examples, such as "macro.h" or "function.h".

Signed-off-by: Chen Wang <[email protected]>
@github-actions github-actions bot added the Doc This PR/issue related with documents label Mar 6, 2025
@unicornx unicornx requested a review from Rbb666 March 6, 2025 03:13
@unicornx
Copy link
Contributor Author

unicornx commented Mar 6, 2025

@1078249029 请 review

@Rbb666 Rbb666 merged commit 3c8b235 into RT-Thread:master Mar 6, 2025
4 checks passed
@unicornx unicornx deleted the dev-doxygen-examples-groups branch March 6, 2025 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc This PR/issue related with documents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants