Skip to content

[doxygen] Fix some comments in rtservice.h #6894

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 2, 2023

Conversation

tuduweb
Copy link
Contributor

@tuduweb tuduweb commented Feb 1, 2023

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

[

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

#6857

F:/development/rtos/rt-thread/include/rtservice.h:131: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:132: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:139: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:141: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:149: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:150: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:151: warning: Found unknown command '@member'
F:/development/rtos/rt-thread/include/rtservice.h:160: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:162: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:163: warning: Found unknown command '@member'
F:/development/rtos/rt-thread/include/rtservice.h:173: warning: Found unknown command '@ptr'
F:/development/rtos/rt-thread/include/rtservice.h:174: warning: Found unknown command '@type'
F:/development/rtos/rt-thread/include/rtservice.h:175: warning: Found unknown command '@member'
F:/development/rtos/rt-thread/include/rtservice.h:270: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:271: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:278: warning: Found unknown command '@pos'
F:/development/rtos/rt-thread/include/rtservice.h:279: warning: Found unknown command '@head'
F:/development/rtos/rt-thread/include/rtservice.h:280: warning: Found unknown command '@member'
F:/development/rtos/rt-thread/include/rtservice.h:289: warning: Found unknown command '@ptr'
F:/development/rtos/rt-thread/include/rtservice.h:290: warning: Found unknown command '@type'
F:/development/rtos/rt-thread/include/rtservice.h:291: warning: Found unknown command '@member'
F:/development/rtos/rt-thread/include/rtservice.h:300: warning: Found unknown command '@ptr'
F:/development/rtos/rt-thread/include/rtservice.h:301: warning: Found unknown command '@type'
F:/development/rtos/rt-thread/include/rtservice.h:302: warning: Found unknown command '@member'

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

fix the comment via regex

在什么测试环境下测试通过 (what is the test environment)

rebuild, warnings disappear.

]

当前拉取/合并请求的状态 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

@CLAassistant
Copy link

CLAassistant commented Feb 1, 2023

CLA assistant check
All committers have signed the CLA.

@supperthomas
Copy link
Member

+1

@supperthomas
Copy link
Member

感谢pr

@mysterywolf mysterywolf merged commit 4d6ceff into RT-Thread:master Feb 2, 2023
@tuduweb
Copy link
Contributor Author

tuduweb commented Feb 2, 2023

感谢pr

请问,有没有什么其它一些工作可以参与进来的呢? @supperthomas

@supperthomas
Copy link
Member

感谢pr

请问,有没有什么其它一些工作可以参与进来的呢? @supperthomas

https://github.com/RT-Thread/rt-thread/contribute

@supperthomas
Copy link
Member

感谢pr

请问,有没有什么其它一些工作可以参与进来的呢? @supperthomas

这个doxygen里面内容也有一些问题,仔细看看。也还有很多工作。

@tuduweb
Copy link
Contributor Author

tuduweb commented Feb 2, 2023

感谢pr

请问,有没有什么其它一些工作可以参与进来的呢? @supperthomas

这个doxygen里面内容也有一些问题,仔细看看。也还有很多工作。

好的,感谢。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants