Skip to content

[Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424

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
Open
supperthomas opened this issue Sep 11, 2024 · 3 comments
Open

[Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424

supperthomas opened this issue Sep 11, 2024 · 3 comments
Assignees
@1078249029
Labels
good first issue Good for newcomers 新手任务

Comments

@supperthomas
Copy link
Member

supperthomas commented Sep 11, 2024 •
edited
Loading

Describe problem solved by the proposed feature

https://github.com./RT-Thread/rt-thread/tree/master/components/drivers/include/drivers

目前driver相关的doxygen中缺少一些注释，希望能添加doxygen注释和对应的example，方便后续开发和维护

Describe your preferred solution

参考doxygen链接
https://supperthomas.github.io/RTT_doxygen_API/

Describe possible alternatives

No response
@supperthomas supperthomas added the good first issue Good for newcomers 新手任务 label Sep 11, 2024
@supperthomas supperthomas mentioned this issue Sep 14, 2024
Merged
9 tasks
This was referenced Sep 24, 2024
Merged
Merged
Merged
This was referenced Oct 5, 2024
Merged
Merged
@supperthomas supperthomas mentioned this issue Dec 24, 2024
Open
@1078249029 1078249029 mentioned this issue Jan 24, 2025
Merged
10 tasks
1078249029 added a commit to 1078249029/rt-thread that referenced this issue Jan 25, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
d16b550 
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 1078249029 mentioned this issue Jan 25, 2025
Merged
10 tasks
1078249029 added a commit to 1078249029/rt-thread that referenced this issue Jan 25, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
87e5277 
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 issue Jan 25, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
1e184e6 
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 issue Jan 26, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
524a038 
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 issue Jan 26, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
79ad0cc 
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 issue Jan 26, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
c860686 
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 issue Jan 26, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h
3865620 
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 issue Jan 27, 2025
@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 pushed a commit that referenced this issue Jan 27, 2025
@1078249029
[doxygen] add doxygen comment for clk.c and clk.h (#9950)
6481633 
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.

Signed-off-by: 1078249029 <[email protected]>
1078249029 added a commit to 1078249029/rt-thread that referenced this issue 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 issue 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 1078249029 mentioned this issue Jan 30, 2025
Closed
10 tasks
@1078249029
Copy link
Contributor

任务给我吧

@unicornx
Copy link
Contributor

unicornx commented Feb 20, 2025 •
edited
Loading

  1. 本 issue [Feature] [doc] doxygen文档中缺少driver相关的doxygen #9424 涉及的改动比较多，所以针对特定的修改，需要将其分解，而这个 issue 来则用来 tracking 其他分解的 issue。
    • 按照 device 的类型分别提 pr
    • 涉及到 utest 单独提 pr
  2. utest 中，device/driver 依赖于具体的硬件，需要考虑一个方案，如何不依赖于硬件，打桩？模拟？模拟外设的 packge
  3. document 的改进方案

@unicornx unicornx mentioned this issue Mar 3, 2025
Merged
10 tasks
@unicornx
Copy link
Contributor

unicornx commented Mar 3, 2025

Driver 相关 PR 总结：

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@1078249029 1078249029

Labels
good first issue Good for newcomers 新手任务
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@unicornx @supperthomas @1078249029