Skip to content

doxygen: finsh: Normalize macro definitions #10006

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
Feb 19, 2025

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Feb 19, 2025

Changes only related to documentation.

Regular macro definitions according to [1].

Link: https://rt-thread.github.io/rt-thread/page_howto_macro.html [1]

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

[

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

整理 finsh API 文档中的 marco

你的解决方案是什么 (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自查

@unicornx unicornx changed the title doxygen: finsh: Normalize macro definitions WIP: doxygen: finsh: Normalize macro definitions Feb 19, 2025
Regular macro definitions according to [1].

Note: for variadic macros such as MSH_CMD_EXPORT, we can
not use normal @param command, otherwise doxygen will
report "@param is not found in the argument list of ...".
So I just write the parameters by manual.

Link: https://rt-thread.github.io/rt-thread/page_howto_macro.html [1]

Signed-off-by: Chen Wang <[email protected]>
@unicornx unicornx changed the title WIP: doxygen: finsh: Normalize macro definitions doxygen: finsh: Normalize macro definitions Feb 19, 2025
@unicornx unicornx added Doc This PR/issue related with documents and removed component: finsh Component labels Feb 19, 2025
@supperthomas supperthomas merged commit 14cfc72 into RT-Thread:master Feb 19, 2025
47 checks passed
@unicornx unicornx deleted the dev-finsh-code branch February 24, 2025 00:16
kurisaW pushed a commit to kurisaW/rt-thread that referenced this pull request Mar 18, 2025
Regular macro definitions according to [1].

Note: for variadic macros such as MSH_CMD_EXPORT, we can
not use normal @param command, otherwise doxygen will
report "@param is not found in the argument list of ...".
So I just write the parameters by manual.

Link: https://rt-thread.github.io/rt-thread/page_howto_macro.html [1]

Signed-off-by: Chen Wang <[email protected]>
kurisaW pushed a commit to kurisaW/rt-thread that referenced this pull request Mar 19, 2025
Regular macro definitions according to [1].

Note: for variadic macros such as MSH_CMD_EXPORT, we can
not use normal @param command, otherwise doxygen will
report "@param is not found in the argument list of ...".
So I just write the parameters by manual.

Link: https://rt-thread.github.io/rt-thread/page_howto_macro.html [1]

Signed-off-by: Chen Wang <[email protected]>
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