pinctrl: aspeed: placate kernel-doc warnings

rddunlap · Linus Walleij · commit 5fa9d19b3fb6 · 2021-08-10T15:29:44.000+02:00
Eliminate kernel-doc warnings in drivers/pinctrl/aspeed by using proper kernel-doc notation. Fixes these kernel-doc warnings: drivers/pinctrl/aspeed/pinmux-aspeed.c:61: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Query the enabled or disabled state for a mux function's signal on a pin drivers/pinctrl/aspeed/pinctrl-aspeed.c:135: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Search for the signal expression needed to enable the pin's signal for the Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reported-by: kernel test robot <lkp@intel.com> Cc: Aditya Srivastava <yashsri421@gmail.com> Cc: Andrew Jeffery <andrew@aj.id.au> Cc: linux-aspeed@lists.ozlabs.org Cc: openbmc@lists.ozlabs.org Cc: Linus Walleij <linus.walleij@linaro.org> Cc: linux-gpio@vger.kernel.org Acked-by: Andrew Jeffery <andrew@aj.id.au> Link: https://lore.kernel.org/r/20210723034840.8752-1-rdunlap@infradead.org Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
diff --git a/drivers/pinctrl/aspeed/pinctrl-aspeed.c b/drivers/pinctrl/aspeed/pinctrl-aspeed.c
@@ -133,8 +133,8 @@ static int aspeed_disable_sig(struct aspeed_pinmux_data *ctx,
 }
 
 /**
- * Search for the signal expression needed to enable the pin's signal for the
- * requested function.
+ * aspeed_find_expr_by_name - Search for the signal expression needed to
+ * enable the pin's signal for the requested function.
  *
  * @exprs: List of signal expressions (haystack)
  * @name: The name of the requested function (needle)
diff --git a/drivers/pinctrl/aspeed/pinmux-aspeed.c b/drivers/pinctrl/aspeed/pinmux-aspeed.c
@@ -59,7 +59,8 @@ int aspeed_sig_desc_eval(const struct aspeed_sig_desc *desc,
 }
 
 /**
- * Query the enabled or disabled state for a mux function's signal on a pin
+ * aspeed_sig_expr_eval - Query the enabled or disabled state for a
+ * mux function's signal on a pin
  *
  * @ctx: The driver context for the pinctrl IP
  * @expr: An expression controlling the signal for a mux function on a pin

Original file line number	Diff line number	Diff line change
`@@ -133,8 +133,8 @@ static int aspeed_disable_sig(struct aspeed_pinmux_data *ctx,`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`/**`
`136`		`- * Search for the signal expression needed to enable the pin's signal for the`
`137`		`- * requested function.`
	`136`	`+ * aspeed_find_expr_by_name - Search for the signal expression needed to`
	`137`	`+ * enable the pin's signal for the requested function.`
`138`	`138`	`*`
`139`	`139`	`* @exprs: List of signal expressions (haystack)`
`140`	`140`	`* @name: The name of the requested function (needle)`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,8 @@ int aspeed_sig_desc_eval(const struct aspeed_sig_desc *desc,`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`/**`
`62`		`- * Query the enabled or disabled state for a mux function's signal on a pin`
	`62`	`+ * aspeed_sig_expr_eval - Query the enabled or disabled state for a`
	`63`	`+ * mux function's signal on a pin`
`63`	`64`	`*`
`64`	`65`	`* @ctx: The driver context for the pinctrl IP`
`65`	`66`	`* @expr: An expression controlling the signal for a mux function on a pin`