powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function

PATCH Applied Yang Li 3 participants 3 messages Mar 1, 2024

Subsystems (2)

Power management core Dynamic thermal power management (dtpm)

lore

Share & tools

lore

Yang Li

author

2024-03-01 08:40 UTC #0 lore raw

PATCH 1/1 powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function

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 <[email protected]>

---
 drivers/powercap/dtpm.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

drivers/powercap/dtpm.c +1 -1

index ce920f17f45f..f390665743c4 100644
@@ -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

Signature · 1 line

2.20.1.7.g153144c

Randy Dunlap

Reviewed-by on v1 1/1

2024-03-01 19:24 UTC #1 lore raw

Quoted 6 lines · Yang Li

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 <[email protected]>

Reviewed-by Randy Dunlap <[email protected]>

Thanks.

Quoted 17 lines

---
 drivers/powercap/dtpm.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

drivers/powercap/dtpm.c +1 -1

index ce920f17f45f..f390665743c4 100644
@@ -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

Signature · 1 line

#Randy

Rafael J. Wysocki

maintainer Applied

2024-03-01 20:41 UTC #2 lore raw

Quoted 4 lines · Randy Dunlap

On 3/1/24 00:18, Yang Li wrote:

Quoted 8 lines

Quoted 6 lines
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 <[email protected]>
Reviewed-by Randy Dunlap <[email protected]>

Applied, thanks!