Skip to content

Commit 524a038

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 1e184e6 commit 524a038

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

components/drivers/clk/clk.c

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -454,13 +454,8 @@ static void clk_unprepare(struct rt_clk *clk, struct rt_clk_node *clk_np)
454454
}
455455
}
456456

457-
/**
458-
* @brief Unprepare clock
459-
*
460-
* @param clk point to clock
461-
*
462-
*/
463-
void rt_clk_unprepare(struct rt_clk *clk)
457+
458+
rt_err_t rt_clk_unprepare(struct rt_clk *clk)
464459
{
465460

466461
RT_DEBUG_NOT_IN_INTERRUPT;

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-
void 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-
void 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)