doxygen: group examples in subpages #10082
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
将 doxygen 的例子分组后显示在不同的 page 上,这样可以在文档中方便地链接到相关类型的 page。譬如 macro 的例子有自己单独的 page,function 的例子有自己单独的 page,这样就和各自的代码例子,譬如 macro.h 或者 function.h 对应起来了。
Module 部分页面未分组前的效果:

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

分组后可以通过页面链接快速跳转到对应的例子的 html 渲染效果:
macro 的 doxygen 注释渲染后的效果,现在集中在一个独立的页面上,方便在线随时查看。

拉取/合并请求描述:(PR description)
[
为什么提交这份PR (why to submit this PR)
见前面 PR 描述。
你的解决方案是什么 (what is your solution)
请提供验证的bsp和config (provide the config and bsp)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality:
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0
代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up