Skip to content

doxygen: improve howto#10084

Merged
Rbb666 merged 1 commit intoRT-Thread:masterfrom
unicornx:dev-doxygen-howto-improve
Mar 10, 2025
Merged

doxygen: improve howto#10084
Rbb666 merged 1 commit intoRT-Thread:masterfrom
unicornx:dev-doxygen-howto-improve

Conversation

@unicornx
Copy link
Contributor

@unicornx unicornx commented Mar 6, 2025

  • 增加说明如何在注释中对 macro 分组
  • 增加说明对于那些 structure 成员变量名过长的情况采用新的方式增加注释。
  • 对原来采用 html 文件名方式引用的地方采用 group 名字,方便以后移植。

拉取/合并请求描述:(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自查

- Add description on how to group macros.
- Add description for structs on how to write comments
  for members when the name of member is too.
- Use @ref to link group instead of the html filenames.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
@github-actions github-actions bot added the Doc This PR/issue related with documents label Mar 6, 2025
@unicornx
Copy link
Contributor Author

unicornx commented Mar 6, 2025

@1078249029 FYI。针对注释对齐的要求我想了一下还是不写了,这个太琐碎了,还是让作者自己决定吧。我们自己写的时候尽量让代码美观一些就好了。

@unicornx unicornx requested a review from Rbb666 March 6, 2025 08:02
@Rbb666 Rbb666 merged commit 94afe6a into RT-Thread:master Mar 10, 2025
4 checks passed
@unicornx unicornx deleted the dev-doxygen-howto-improve branch March 12, 2025 02:17
@Rbb666 Rbb666 mentioned this pull request Sep 18, 2025
11 tasks
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