pinctrl: aspeed: Fix minor documentation error

Souptick Joarder · linusw · commit 333944c7c375 · 2021-05-19T02:11:18.000+02:00
Kernel test robot throws below warning -> drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c:2705: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c:2614: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinctrl-aspeed.c:111: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/pinctrl/aspeed/pinmux-aspeed.c:24: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst Fix minor documentation error. Reported-by: kernel test robot <lkp@intel.com> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com> Cc: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Andrew Jeffery <andrew@aj.id.au> Link: https://lore.kernel.org/r/1619353584-8196-1-git-send-email-jrdr.linux@gmail.com Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
diff --git a/drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c b/drivers/pinctrl/aspeed/pinctrl-aspeed-g5.c
@@ -2702,8 +2702,8 @@ static int aspeed_g5_sig_expr_eval(struct aspeed_pinmux_data *ctx,
 }
 
 /**
- * Configure a pin's signal by applying an expression's descriptor state for
- * all descriptors in the expression.
+ * aspeed_g5_sig_expr_set() - Configure a pin's signal by applying an
+ * expression's descriptor state for all descriptors in the expression.
  *
  * @ctx: The pinmux context
  * @expr: The expression associated with the function whose signal is to be
diff --git a/drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c b/drivers/pinctrl/aspeed/pinctrl-aspeed-g6.c
@@ -2611,8 +2611,8 @@ static struct aspeed_pin_config aspeed_g6_configs[] = {
 };
 
 /**
- * Configure a pin's signal by applying an expression's descriptor state for
- * all descriptors in the expression.
+ * aspeed_g6_sig_expr_set() - Configure a pin's signal by applying an
+ * expression's descriptor state for all descriptors in the expression.
  *
  * @ctx: The pinmux context
  * @expr: The expression associated with the function whose signal is to be
diff --git a/drivers/pinctrl/aspeed/pinctrl-aspeed.c b/drivers/pinctrl/aspeed/pinctrl-aspeed.c
@@ -108,7 +108,8 @@ static int aspeed_sig_expr_disable(struct aspeed_pinmux_data *ctx,
 }
 
 /**
- * Disable a signal on a pin by disabling all provided signal expressions.
+ * aspeed_disable_sig() - Disable a signal on a pin by disabling all provided
+ * signal expressions.
  *
  * @ctx: The pinmux context
  * @exprs: The list of signal expressions (from a priority level on a pin)
diff --git a/drivers/pinctrl/aspeed/pinmux-aspeed.c b/drivers/pinctrl/aspeed/pinmux-aspeed.c
@@ -21,7 +21,8 @@ static inline void aspeed_sig_desc_print_val(
 }
 
 /**
- * Query the enabled or disabled state of a signal descriptor
+ * aspeed_sig_desc_eval() - Query the enabled or disabled state of a signal
+ * descriptor.
  *
  * @desc: The signal descriptor of interest
  * @enabled: True to query the enabled state, false to query disabled state

Original file line number	Diff line number	Diff line change
`@@ -2702,8 +2702,8 @@ static int aspeed_g5_sig_expr_eval(struct aspeed_pinmux_data *ctx,`
`2702`	`2702`	`}`
`2703`	`2703`
`2704`	`2704`	`/**`
`2705`		`- * Configure a pin's signal by applying an expression's descriptor state for`
`2706`		`- * all descriptors in the expression.`
	`2705`	`+ * aspeed_g5_sig_expr_set() - Configure a pin's signal by applying an`
	`2706`	`+ * expression's descriptor state for all descriptors in the expression.`
`2707`	`2707`	`*`
`2708`	`2708`	`* @ctx: The pinmux context`
`2709`	`2709`	`* @expr: The expression associated with the function whose signal is to be`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,8 @@ static int aspeed_sig_expr_disable(struct aspeed_pinmux_data *ctx,`
`108`	`108`	`}`
`109`	`109`
`110`	`110`	`/**`
`111`		`- * Disable a signal on a pin by disabling all provided signal expressions.`
	`111`	`+ * aspeed_disable_sig() - Disable a signal on a pin by disabling all provided`
	`112`	`+ * signal expressions.`
`112`	`113`	`*`
`113`	`114`	`* @ctx: The pinmux context`
`114`	`115`	`* @exprs: The list of signal expressions (from a priority level on a pin)`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ static inline void aspeed_sig_desc_print_val(`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * Query the enabled or disabled state of a signal descriptor`
	`24`	`+ * aspeed_sig_desc_eval() - Query the enabled or disabled state of a signal`
	`25`	`+ * descriptor.`
`25`	`26`	`*`
`26`	`27`	`* @desc: The signal descriptor of interest`
`27`	`28`	`* @enabled: True to query the enabled state, false to query disabled state`