Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[doxygen] add doxygen comment for clk.c and clk.h #9950

Merged
merged 1 commit into from
Jan 27, 2025
Merged

[doxygen] add doxygen comment for clk.c and clk.h #9950

merged 1 commit into from
Jan 27, 2025

Conversation

1078249029
Copy link
Contributor

@1078249029 1078249029 commented Jan 25, 2025 •
edited
Loading

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

[

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

Accroding to #9947 and #9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations.

  • rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies.
  • clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify.
  • clk_release implements may be incomplete, so I just marked in comment.

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

@github-actions github-actions bot added BSP Doc This PR/issue related with documents component: drivers/usb labels Jan 25, 2025
@supperthomas
Copy link
Member

请rebase之后再提交，ci问题处理一下

@1078249029 1078249029 closed this Jan 25, 2025
@1078249029 1078249029 reopened this Jan 25, 2025
@supperthomas supperthomas requested a review from unicornx January 25, 2025 14:22
unicornx
unicornx suggested changes Jan 26, 2025
View reviewed changes
Copy link
Contributor

@unicornx unicornx left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个 PR 的改动除了 doxygen 注释，还改了源代码逻辑，这对 review 和代码维护（譬如 revert 等）都不方便，我们尽量确保一个 PR 只涉及一个主题。

请将两部分改动拆分提交。单纯增加 doxygen 注释的提一个 pr，涉及代码改动 (函数定义的) 的另外提一个 pr（和这个 API 改动相关的 doxygen 注释可以放一起一个 PR）.

另外有个疑问，修改的函数是 API 接口吗，对其他调用的地方有没有影响？请检查一下。

@1078249029
Copy link
Contributor Author

这个 PR 的改动除了 doxygen 注释，还改了源代码逻辑，这对 review 和代码维护（譬如 revert 等）都不方便，我们尽量确保一个 PR 只涉及一个主题。

请将两部分改动拆分提交。单纯增加 doxygen 注释的提一个 pr，涉及代码改动 (函数定义的) 的另外提一个 pr（和这个 API 改动相关的 doxygen 注释可以放一起一个 PR）.

另外有个疑问，修改的函数是 API 接口吗，对其他调用的地方有没有影响？请检查一下。

是API接口，目前只在当前文件产生调用

@supperthomas
Copy link
Member

rebase一下

@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
44087ed 
Accroding to RT-Thread#9947 and RT-Thread#9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations.
    - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies.
    - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify.
    - clk_release implements may be incomplete, so I just marked in comment.

Signed-off-by: 1078249029 <[email protected]>
@supperthomas supperthomas merged commit 6481633 into RT-Thread:master Jan 27, 2025
47 of 48 checks passed
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 27, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h (RT-Thread#9950)
ef80f23 
Accroding to RT-Thread#9947 and RT-Thread#9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations.
    - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies.
    - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify.
    - clk_release implements may be incomplete, so I just marked in comment.

Signed-off-by: 1078249029 <[email protected]>
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 27, 2025
@1078249029
[driver] fix function type and return value for clk.c and clk.h
b11f175 
Accroding to RT-Thread#9950 , function and declaration should be fixed.

Signed-off-by: 1078249029 <[email protected]>
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 27, 2025
@1078249029
[driver] fix function type and return value for clk.c and clk.h
3a83ab1 
Accroding to RT-Thread#9950 , function and declaration should be fixed.

Signed-off-by: 1078249029 <[email protected]>
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 27, 2025
@1078249029
[driver] fix function type and return value for clk.c and clk.h
346c7d0 
Accroding to RT-Thread#9950 , function and declaration should be fixed.

Signed-off-by: 1078249029 <[email protected]>
@1078249029 1078249029 mentioned this pull request Jan 27, 2025
Open
10 tasks
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 28, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h (RT-Thread#9950)
252482c 
Accroding to RT-Thread#9947 and RT-Thread#9424, adding doxygen comment for function in .c files and data structure, macro in .h file is a solution.For this pr, I encountered problem following situations.
    - rt_clk_unprepare function return value type is different from rt_clk_ops so I change type of rt_clk_unprepare and its dependencies.
    - clk_get function may be similar as rt_clk_unprepare but I'm not sure so not modify.
    - clk_release implements may be incomplete, so I just marked in comment.

Signed-off-by: 1078249029 <[email protected]>
1078249029 added a commit to 1078249029/rt-thread that referenced this pull request Jan 28, 2025
@1078249029
[driver] fix function type and return value for clk.c and clk.h
840cfd8 
Accroding to RT-Thread#9950 , function and declaration should be fixed.

Signed-off-by: 1078249029 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@unicornx unicornx unicornx requested changes

@supperthomas supperthomas supperthomas approved these changes

@mysterywolf mysterywolf mysterywolf approved these changes

@Cathy-lulu Cathy-lulu Awaiting requested review from Cathy-lulu Cathy-lulu is a code owner

Assignees
No one assigned
Labels
BSP component: drivers/clk component: drivers/usb component: drivers Component Doc This PR/issue related with documents
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@1078249029 @supperthomas @unicornx @mysterywolf