Skip to content

Commit c860686

Browse files
committed
[doxygen] add doxygen comment for clk.c and clk.h
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]>
1 parent 79ad0cc commit c860686

File tree

1 file changed

+2
-2
lines changed
  • components/drivers/include/drivers

1 file changed

+2
-2
lines changed

components/drivers/include/drivers/clk.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ rt_err_t rt_clk_notifier_unregister(struct rt_clk *clk, struct rt_clk_notifier *
160160
rt_err_t rt_clk_set_parent(struct rt_clk *clk, struct rt_clk *clk_parent);
161161

162162
rt_err_t rt_clk_prepare(struct rt_clk *clk);
163-
rt_err_t rt_clk_unprepare(struct rt_clk *clk);
163+
rt_err_t rt_clk_unprepare(struct rt_clk *clk);
164164

165165
rt_err_t rt_clk_enable(struct rt_clk *clk);
166166
void rt_clk_disable(struct rt_clk *clk);
@@ -169,7 +169,7 @@ rt_err_t rt_clk_prepare_enable(struct rt_clk *clk);
169169
void rt_clk_disable_unprepare(struct rt_clk *clk);
170170

171171
rt_err_t rt_clk_array_prepare(struct rt_clk_array *clk_arr);
172-
rt_err_t rt_clk_array_unprepare(struct rt_clk_array *clk_arr);
172+
rt_err_t rt_clk_array_unprepare(struct rt_clk_array *clk_arr);
173173

174174
rt_err_t rt_clk_array_enable(struct rt_clk_array *clk_arr);
175175
void rt_clk_array_disable(struct rt_clk_array *clk_arr);

0 commit comments

Comments
 (0)