Re: [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function

From: Randy Dunlap
Date: Fri Mar 01 2024 - 14:25:20 EST




On 3/1/24 00:18, Yang Li wrote:
> The existing comment block above the dtpm_create_hierarchy function
> does not conform to the kernel-doc standard. This patch fixes the
> documentation to match the expected kernel-doc format, which includes
> a structured documentation header with param and return value.
>
> Signed-off-by: Yang Li <yang.lee@xxxxxxxxxxxxxxxxx>

Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Thanks.

> ---
> drivers/powercap/dtpm.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/powercap/dtpm.c b/drivers/powercap/dtpm.c
> index ce920f17f45f..f390665743c4 100644
> --- a/drivers/powercap/dtpm.c
> +++ b/drivers/powercap/dtpm.c
> @@ -522,7 +522,7 @@ static int dtpm_for_each_child(const struct dtpm_node *hierarchy,
>
> /**
> * dtpm_create_hierarchy - Create the dtpm hierarchy
> - * @hierarchy: An array of struct dtpm_node describing the hierarchy
> + * @dtpm_match_table: Pointer to the array of device ID structures
> *
> * The function is called by the platform specific code with the
> * description of the different node in the hierarchy. It creates the

--
#Randy