powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy() function

Yang Li · rafaeljw · commit 44c9cf9aaa48 · 2024-03-01T21:39:10.000+01:00
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 &lt;yang.lee@linux.alibaba.com&gt;
Reviewed-by: Randy Dunlap &lt;rdunlap@infradead.org&gt;
Signed-off-by: Rafael J. Wysocki &lt;rafael.j.wysocki@intel.com&gt;
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -522,7 +522,7 @@ static int dtpm_for_each_child(const struct dtpm_node *hierarchy,`
`522`	`522`
`523`	`523`	`/**`
`524`	`524`	`* dtpm_create_hierarchy - Create the dtpm hierarchy`
`525`		`- * @hierarchy: An array of struct dtpm_node describing the hierarchy`
	`525`	`+ * @dtpm_match_table: Pointer to the array of device ID structures`
`526`	`526`	`*`
`527`	`527`	`* The function is called by the platform specific code with the`
`528`	`528`	`* description of the different node in the hierarchy. It creates the`