| Message ID | 20240301081802.114308-1-yang.lee@linux.alibaba.com (mailing list archive) |
|---|---|
| State | In Next |
| Delegated to: | Rafael Wysocki |
| Headers | show |
| Series | [-next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function | expand |
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@linux.alibaba.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> 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
On Fri, Mar 1, 2024 at 8:24 PM Randy Dunlap <rdunlap@infradead.org> wrote: > > > > 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@linux.alibaba.com> > > Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Applied, thanks!
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
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@linux.alibaba.com> --- drivers/powercap/dtpm.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)